Package com.redwood.scheduler.api.model

Interface RestrictedSchedulerSessionSpecification

    • Method Detail

      • getBaseUser

        String getBaseUser()
        Get the value for BaseUser. (The base user that provides the read only access part of the session) 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.

      • getRemoteUserInfo

        String getRemoteUserInfo()
        Get the value for RemoteUserInfo. (The information to identify the remote user (recorded for auditing)) 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.

      • getInfo

        String getInfo()
        Get the value for Info. (The purpose of the Restricted Scheduler Session (recorded for auditing)) 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.

      • getExpiry

        DateTimeZone getExpiry()
        Get the value for Expiry. (When the Restricted Scheduler Session Specification expires) 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.

      • setRemoteUserInfo

        void setRemoteUserInfo​(String newRemoteUserInfo)
        Set the value for RemoteUserInfo. (The information to identify the remote user (recorded for auditing)) This value is mandatory.
        Parameters:
        newRemoteUserInfo - the new value for RemoteUserInfo. 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.

      • setInfo

        void setInfo​(String newInfo)
        Set the value for Info. (The purpose of the Restricted Scheduler Session (recorded for auditing)) This value is mandatory.
        Parameters:
        newInfo - the new value for Info. 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.

      • setExpiry

        void setExpiry​(DateTimeZone newExpiry)
        Set the value for Expiry. (When the Restricted Scheduler Session Specification expires) This value is mandatory.
        Parameters:
        newExpiry - the new value for Expiry. 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.

      • allowWrite

        void allowWrite​(SchedulerEntity entity)
        Grant write access the SchedulerEntity within the restricted session
        Parameters:
        entity - The entity to grant access to

      • getSSOToken

        String getSSOToken()
        Generate an SSO Token based upon the restricted scheduler session specification. NOTE: this is not safe for URLs and needs to be encoded for use in URLs.
        Returns:
        the SSO token as a base64 encoded string

      • getURLEncodedSSOToken

        String getURLEncodedSSOToken()
        Generate an SSO Token based upon the restricted scheduler session specification that is URL Encoded and can be used within a URL
        Returns:
        the SSO token as URL encoded token

      • 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.

      • checkUsePrivilege

        RequiredPermission checkUsePrivilege()
        Check whether or not the use 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.

      • 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.