Interface ProfileEntryEnablerProfileSession

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

This session provides methods to retrieve ProfileEntryEnabler to Profile mappings. A ProfileEntryEnabler may appear in multiple Profile objects. Each profile may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupProfileEntryEnablerProfileMappings

      boolean canLookupProfileEntryEnablerProfileMappings()
      Tests if this user can perform lookups of profile entry enabler/profile mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeProfileEntryEnablerProfileView

      void useComparativeProfileEntryEnablerProfileView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryProfileEntryEnablerProfileView

      void usePlenaryProfileEntryEnablerProfileView()
      A complete view of the ProfileEntryEnabler and Profile returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getProfileEntryEnablerIdsByProfile

      IdList getProfileEntryEnablerIdsByProfile(Id profileId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ProfileEntryEnablerIds associated with a Profile .
      Parameters:
      profileId - Id of the Profile
      Returns:
      list of related profile entry enabler Ids
      Throws:
      NotFoundException - profileId is not found
      NullArgumentException - profileId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProfileEntryEnablersByProfile

      ProfileEntryEnablerList getProfileEntryEnablersByProfile(Id profileId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of profile entry enablers associated with a Profile .
      Parameters:
      profileId - Id of the Profile
      Returns:
      list of related profile entry enablers
      Throws:
      NotFoundException - profileId is not found
      NullArgumentException - profileId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProfileEntryEnablerIdsByProfiles

      IdList getProfileEntryEnablerIdsByProfiles(IdList profileIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of ProfileEntryEnablerIds corresponding to a list of Profiles .
      Parameters:
      profileIds - list of profile Ids
      Returns:
      list of profile entry enabler Ids
      Throws:
      NullArgumentException - profileIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProfileEntryEnablersByProfiles

      ProfileEntryEnablerList getProfileEntryEnablersByProfiles(IdList profileIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of profile entry enablers corresponding to a list of Profiles .
      Parameters:
      profileIds - list of profile Ids
      Returns:
      list of profile entry enablers
      Throws:
      NullArgumentException - profileIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProfileIdsByProfileEntryEnabler

      IdList getProfileIdsByProfileEntryEnabler(Id profileEntryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Profile Ids mapped to a ProfileEntryEnabler .
      Parameters:
      profileEntryEnablerId - Id of a ProfileEntryEnabler
      Returns:
      list of profiles
      Throws:
      NotFoundException - profileEntryEnablerId is not found
      NullArgumentException - profileEntryEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProfilesByProfileEntryEnabler

      ProfileList getProfilesByProfileEntryEnabler(Id profileEntryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Profiles mapped to a ProfileEntryEnabler .
      Parameters:
      profileEntryEnablerId - Id of a ProfileEntryEnabler
      Returns:
      list of profiles
      Throws:
      NotFoundException - profileEntryEnablerId is not found
      NullArgumentException - profileEntryEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.