Interface Subject

    • Method Detail

      • isActive

        boolean isActive()
        Get the value for Active. (This field is only valid when the Subject is of type User, and in that case indicates whether or not this user is valid.)
        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.
      • getComment

        String getComment()
        Get the value for Comment. (Optional comment)
        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. (Optional description)
        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.
      • getSearchDescription

        String getSearchDescription()
        Get the value for SearchDescription. (Optional description used to search on)
        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.
      • isDisabled

        boolean isDisabled()
        Get the value for Disabled. (This field is only valid when the Subject is of type User, and in that case indicates whether or not this user is disabled (deleted for us). Once disabled the user is deleted for us, and cannot be enabled again.)
        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.
      • getName

        String getName()
        Get the value for Name. (The unique name of this object) 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.
      • isGrantable

        boolean isGrantable()
        Get the value for Grantable. (Can this subject be granted to other subjects?)
        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.
      • isGrantToable

        boolean isGrantToable()
        Get the value for GrantToable. (Can this subject be granted other subjects?)
        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.
      • getRemoteName

        String getRemoteName()
        Get the value for RemoteName. (A way of uniquely identifying this Subject on the Remote Authentication system.)
        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 name of this object, normalized to allow for convenient database searching.) 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.
      • isScreenReader

        boolean isScreenReader()
        Get the value for ScreenReader. (Indicates whether this subject uses a screen-reader.)
        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.
      • isSuperReader

        boolean isSuperReader()
        Get the value for SuperReader. (Whether this subject is a super-reader or not.)
        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.
      • getType

        SubjectType getType()
        Get the value for Type. (What type of Subject does this Subject represent?) 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.
      • getEmail

        String getEmail()
        Get the value for Email. (Email address for notifications.)
        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.
      • getSearchEmail

        String getSearchEmail()
        Get the value for SearchEmail. (Search case of Email field.)
        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.
      • getNotificationType

        NotificationType getNotificationType()
        Get the value for NotificationType. (The type of notifications this user receives.) 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.
      • getMaxAttachmentSize

        Long getMaxAttachmentSize()
        Get the value for MaxAttachmentSize. (The maximum size of attachments to emails.)
        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.
      • getProxySubjectStartDate

        DateTimeZone getProxySubjectStartDate()
        Get the value for ProxySubjectStartDate. (The start date for the out of office (ProxySubject) of this user.)
        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.
      • getProxySubjectEndDate

        DateTimeZone getProxySubjectEndDate()
        Get the value for ProxySubjectEndDate. (The end date (inclusive) for the out of office (ProxySubject) of this user.)
        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.
      • setActive

        void setActive​(boolean newActive)
        Set the value for Active. (This field is only valid when the Subject is of type User, and in that case indicates whether or not this user is valid.)
        Parameters:
        newActive - the new value for Active.
        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.
      • setComment

        void setComment​(String newComment)
        Set the value for Comment. (Optional comment) This value is optional.
        Parameters:
        newComment - the new value for Comment.
        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.
      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (Optional description) This value is optional.
        Parameters:
        newDescription - the new value for Description.
        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.
      • setName

        void setName​(String newName)
        Set the value for Name. (The unique name of this object) This value is mandatory.
        Parameters:
        newName - the new value for Name. If this is null, then the object cannot be persisted.
        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.
      • setRemoteName

        void setRemoteName​(String newRemoteName)
        Set the value for RemoteName. (A way of uniquely identifying this Subject on the Remote Authentication system.) This value is optional.
        Parameters:
        newRemoteName - the new value for RemoteName.
        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.
      • setScreenReader

        void setScreenReader​(boolean newScreenReader)
        Set the value for ScreenReader. (Indicates whether this subject uses a screen-reader.)
        Parameters:
        newScreenReader - the new value for ScreenReader.
        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.
      • setType

        void setType​(SubjectType newType)
        Set the value for Type. (What type of Subject does this Subject represent?) This value is mandatory.
        Parameters:
        newType - the new value for Type. If this is null, then the object cannot be persisted.
        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.
      • setEmail

        void setEmail​(String newEmail)
        Set the value for Email. (Email address for notifications.) This value is optional.
        Parameters:
        newEmail - the new value for Email.
        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.
      • setNotificationType

        void setNotificationType​(NotificationType newNotificationType)
        Set the value for NotificationType. (The type of notifications this user receives.) This value is mandatory.
        Parameters:
        newNotificationType - the new value for NotificationType. If this is null, then the object cannot be persisted.
        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.
      • setMaxAttachmentSize

        void setMaxAttachmentSize​(Long newMaxAttachmentSize)
        Set the value for MaxAttachmentSize. (The maximum size of attachments to emails.) This value is optional.
        Parameters:
        newMaxAttachmentSize - the new value for MaxAttachmentSize.
        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.
      • setProxySubjectStartDate

        void setProxySubjectStartDate​(DateTimeZone newProxySubjectStartDate)
        Set the value for ProxySubjectStartDate. (The start date for the out of office (ProxySubject) of this user.) This value is optional.
        Parameters:
        newProxySubjectStartDate - the new value for ProxySubjectStartDate.
        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.
      • setProxySubjectEndDate

        void setProxySubjectEndDate​(DateTimeZone newProxySubjectEndDate)
        Set the value for ProxySubjectEndDate. (The end date (inclusive) for the out of office (ProxySubject) of this user.) This value is optional.
        Parameters:
        newProxySubjectEndDate - the new value for ProxySubjectEndDate.
        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.
      • deactivateUser

        void deactivateUser()
        Deactivate this user so that they can no longer log in.
      • activateUser

        void activateUser()
        Activate this user so that they can log in.
      • reenableUser

        void reenableUser()
        Reenable a user after it has been disabled.
      • disableUser

        void disableUser()
        Disables (deletes, but we keep copy) the user permanently.
      • getProxySubject

        Subject getProxySubject()
        Get the ProxySubject.
        Returns:
        ProxySubject
        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.
      • setProxySubject

        void setProxySubject​(Subject newProxySubject)
        Set the value for ProxySubject. This value is optional.
        Parameters:
        newProxySubject - is the object to set ProxySubject to. The proxy subject for a subject.
      • getAssignedSubjectGlobalPrivilegeGrantByGrantedGlobalPrivilege

        SubjectGlobalPrivilegeGrant getAssignedSubjectGlobalPrivilegeGrantByGrantedGlobalPrivilege​(GlobalPrivilege grantedGlobalPrivilege)
        Get the SubjectGlobalPrivilegeGrant by SubjectGlobalPrivilegeLevelGrant.
        Parameters:
        grantedGlobalPrivilege -
        Returns:
        the SubjectGlobalPrivilegeGrant, or null if it could not be found
      • getAssignedSubjectRoleGrantByGrantedSubject

        SubjectRoleGrant getAssignedSubjectRoleGrantByGrantedSubject​(Subject grantedSubject)
        Get the SubjectRoleGrant by SubjectGrants.
        Parameters:
        grantedSubject -
        Returns:
        the SubjectRoleGrant, or null if it could not be found
      • getAssignedSubjectObjectPrivilegeGrantByObjectDefinitionObjectUniqueId

        SubjectObjectPrivilegeGrant getAssignedSubjectObjectPrivilegeGrantByObjectDefinitionObjectUniqueId​(ObjectDefinition objectDefinition,
                                                                                                           Long objectUniqueId)
        Get the SubjectObjectPrivilegeGrant by SubjectSchedulerEntity.
        Parameters:
        objectDefinition -
        objectUniqueId -
        Returns:
        the SubjectObjectPrivilegeGrant, or null if it could not be found
      • getAssignedSubjectObjectTypePrivilegeGrantByObjectDefinitionLevelPartitionOrIsolationGroupUniqueId

        SubjectObjectTypePrivilegeGrant getAssignedSubjectObjectTypePrivilegeGrantByObjectDefinitionLevelPartitionOrIsolationGroupUniqueId​(ObjectDefinition objectDefinition,
                                                                                                                                           GrantLevel level,
                                                                                                                                           Long partitionOrIsolationGroupUniqueId)
        Get the SubjectObjectTypePrivilegeGrant by SubjectObjectTypeLevelGrant.
        Parameters:
        objectDefinition -
        level -
        partitionOrIsolationGroupUniqueId -
        Returns:
        the SubjectObjectTypePrivilegeGrant, or null if it could not be found
      • getSubjectIsolationGroupByIsolationGroup

        SubjectIsolationGroup getSubjectIsolationGroupByIsolationGroup​(IsolationGroup isolationGroup)
        Get the SubjectIsolationGroup by SubjectIsolationGroup.
        Parameters:
        isolationGroup -
        Returns:
        the SubjectIsolationGroup, or null if it could not be found
      • getAssignedToSubjectRoleGrantByGranteeSubject

        SubjectRoleGrant getAssignedToSubjectRoleGrantByGranteeSubject​(Subject granteeSubject)
        Get the SubjectRoleGrant by SubjectGrants.
        Parameters:
        granteeSubject -
        Returns:
        the SubjectRoleGrant, or null if it could not be found