Package com.redwood.scheduler.api.model

Interface ObjectDefinition

    • Method Detail

      • isAllowedGrants

        boolean isAllowedGrants()
        Get the value for AllowedGrants. (Whether or not security grants are possible for this type of object.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getDescription

        String getDescription()
        Get the value for Description. (Returns the translation for the ObjectName.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getObjectName

        String getObjectName()
        Get the value for ObjectName. (The internal name of this ObjectType. Used for debugging and to build the localised name.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getSearchName

        String getSearchName()
        Get the value for SearchName. (The internal name of this ObjectType, normalized to allow for convenient database searching.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isGrantableAtLevel

        boolean isGrantableAtLevel​(GrantLevel level)
        Whether grants can be made for this object-type at the specified level.
        Parameters:
        level - Level to query.
        Returns:
        True if grants can be made for this object-type at the given level, false otherwise.

      • isBusinessKeyObject

        boolean isBusinessKeyObject()
        Can SchedulerEntities for ObjectDefinition be addressed by BusinessKey.
        Returns:
        True if the ObjectDefinition supports BusinessKeys.

      • getBusinessKeyObjectIndex

        ObjectIndex getBusinessKeyObjectIndex()
        Get the BusinessKeyObjectIndex.
        Returns:
        BusinessKeyObjectIndex
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

      • setBusinessKeyObjectIndex

        void setBusinessKeyObjectIndex​(ObjectIndex newBusinessKeyObjectIndex)
        Set the value for BusinessKeyObjectIndex. This value is optional.
        Parameters:
        newBusinessKeyObjectIndex - is the object to set BusinessKeyObjectIndex to. This index is the business key for this object

      • getAlerts

        RWIterable<Alert> getAlerts()
        Get an RWIterable over an ordered collection of Alerts. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. What type of object raised this alert?
        Specified by:
        getAlerts in interface ObjectDefinitionComp
        Returns:
        An RWIterable over an ordered collection of Alert objects .

      • getObjectFieldDefinitionByFieldName

        ObjectFieldDefinition getObjectFieldDefinitionByFieldName​(String fieldName)
        Get the ObjectFieldDefinition by FilterOrderName.
        Parameters:
        fieldName -
        Returns:
        the ObjectFieldDefinition, or null if it could not be found

      • getQueryConditionByName

        QueryCondition getQueryConditionByName​(String name)
        Get the QueryCondition by QueryCondition.
        Parameters:
        name -
        Returns:
        the QueryCondition, or null if it could not be found

      • getQueryFilterByOwnerSubjectName

        QueryFilter getQueryFilterByOwnerSubjectName​(Subject ownerSubject,
                                             String name)
        Get the QueryFilter by ObjectDefinitionUserName.
        Parameters:
        ownerSubject -
        name -
        Returns:
        the QueryFilter, or null if it could not be found

      • checkCreatePrivilege

        RequiredPermission checkCreatePrivilege()
        Check whether or not the create action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkViewPrivilege

        RequiredPermission checkViewPrivilege()
        Check whether or not the view action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkEditPrivilege

        RequiredPermission checkEditPrivilege()
        Check whether or not the edit action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkModifyIndexPrivilege

        RequiredPermission checkModifyIndexPrivilege()
        Check whether or not the modifyIndex action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkDeletePrivilege

        RequiredPermission checkDeletePrivilege()
        Check whether or not the delete action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.