Interface ProfileEntryEnablerRuleApplicationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ProfileEntryEnablerRuleApplicationSession extends OsidSession

This session provides methods to apply ProfileEntryEnablers to ProfileEntries. A ProfileEntry with multiple ProfileEntryEnablers means any positive rule evaluation across the enablers result in an effective ProfileEntry.

Like all OsidSessions, ProfileEntryEnablerRuleApplicationSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getProfileId

      Id getProfileId()
      Gets the Profile Id associated with this session.
      Returns:
      the Profile Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getProfile

      Profile getProfile() throws OperationFailedException, PermissionDeniedException
      Gets the Profile associated with this session.
      Returns:
      the profile
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canAssignProfileEntryEnablers

      boolean canAssignProfileEntryEnablers()
      Tests if this user can alter profile entry enabler/profile entry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignProfileEntryEnablerToProfileEntry

      boolean canAssignProfileEntryEnablerToProfileEntry(Id profileEntryId)
      Tests if this user can alter profile entry enabler/profile entry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Parameters:
      profileEntryId - the Id of the ProfileEntry
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - profileEntryId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableProfileEntryIdsForProfileEntryEnabler

      IdList getAssignableProfileEntryIdsForProfileEntryEnabler(Id profileEntryEnablerId) throws OperationFailedException
      Gets a list of profile entry in which a specific profile entry enabler can be assigned.
      Parameters:
      profileEntryEnablerId - the Id of the ProfileEntryEnabler
      Returns:
      list of assignable profile entry Ids
      Throws:
      NullArgumentException - profileEntryEnablerId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignProfileEntryEnablerToProfileEntry

      void assignProfileEntryEnablerToProfileEntry(Id profileEntryEnablerId, Id profileEntryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing ProfileEntryEnabler to a ProfileEntry .
      Parameters:
      profileEntryEnablerId - the Id of the ProfileEntryEnabler
      profileEntryId - the Id of the ProfileEntry
      Throws:
      AlreadyExistsException - profileEntryEnablerId is already applied to profileEntryId
      NotFoundException - profileEntryEnablerId or profileEntryId not found
      NullArgumentException - profileEntryEnablerId or profileEntryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignProfileEntryEnablerFromProfileEntry

      void unassignProfileEntryEnablerFromProfileEntry(Id profileEntryEnablerId, Id profileEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a ProfileEntryEnabler from a ProfileEntry.
      Parameters:
      profileEntryEnablerId - the Id of the ProfileEntryEnabler
      profileEntryId - the Id of the ProfileEntry
      Throws:
      NotFoundException - profileEntryEnablerId or profileEntryId not found or profileEntryEnablerId not applied to profileEntryId
      NullArgumentException - profileEntryEnablerId or profileEntryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSequenceProfileEntryEnablers

      boolean canSequenceProfileEntryEnablers()
      Tests if this user can order ProfileEntryEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
      Returns:
      false if ProfileEntryEnabler ordering is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • moveProfileEntryEnablerAhead

      void moveProfileEntryEnablerAhead(Id profileEntryEnablerId, Id profileEntryId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Reorders profile entry enablers for a profile entry by moving the specified profile entry enabler in front of a reference profile entry enabler.
      Parameters:
      profileEntryEnablerId - the Id of a ProfileEntryEnabler
      profileEntryId - the Id of a ProfileEntry
      referenceId - the reference profile entry enabler Id
      Throws:
      NotFoundException - profileEntryEnablerId, profileEntryId, or referenceId not found or, profileEntryEnablerId or referenceId not related to profileEntryId
      NullArgumentException - profileEntryEnablerId, profileEntryId, or referenceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • moveProfileEntryEnablerBehind

      void moveProfileEntryEnablerBehind(Id profileEntryEnablerId, Id profileEntryId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Reorders profile entry enablers for a profile entry by moving the specified profile entry enabler behind a reference profile entry enabler.
      Parameters:
      profileEntryEnablerId - the Id of a ProfileEntryEnabler
      profileEntryId - the Id of a ProfileEntry
      referenceId - the reference profile entry enabler Id
      Throws:
      NotFoundException - profileEntryEnablerId, profileEntryId, or referenceId not found or, profileEntryEnablerId or referenceId not related to profileEntryId
      NullArgumentException - profileEntryEnablerId, profileEntryId, or referenceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • orderProfileEntryEnablers

      void orderProfileEntryEnablers(Id[] profileEntryEnablerIds, Id profileEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Reorders a set of profile entry enablers for a profile entry.
      Parameters:
      profileEntryEnablerIds - the Ids for a set of ProfileEntryEnablers
      profileEntryId - the Id of a ProfileEntry
      Throws:
      NotFoundException - profileEntryId not found or, an profileEntryEnablerId not related to profileEntryId
      NullArgumentException - profileEntryEnablerIds or profileEntryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.