Interface ProfileRulesManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, ProfileRulesProfile, Sourceable
public interface ProfileRulesManager extends OsidManager, ProfileRulesProfile

The profile rules manager provides access to profile rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • ProfileEntryEnablerLookupSession : a session to retrieve profile entry enablers
  • ProfileEntryEnablerQuerySession : a session to query for profile entry enablers
  • ProfileEntryEnablerSearchSession : a session to search for profile entry enablers
  • ProfileEntryEnablerAdminSession : a session to create and delete profile entry enablers
  • ProfileEntryEnablerNotificationSession : a session to receive notifications pertaining to profile entry enabler changes
  • ProfileEntryEnablerProfileSession : a session to look up profile entry enabler profile mappings
  • ProfileEntryEnablerProfileAssignmentSession : a session to manage profile entry enabler to profile mappings
  • ProfileEntryEnablerSmartProfileSession : a session to manage dynamic profiles of profile entry enablers
  • ProfileEntryEnablerRuleLookupSession : a session to look up profile entry enabler to profile entry mappings
  • ProfileEntryEnablerRuleApplicationSession : a session to apply profile entry enablers to profile entries

  • Method Details

    • getProfileEntryEnablerLookupSession

      ProfileEntryEnablerLookupSession getProfileEntryEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the profile entry enabler lookup service.
      Returns:
      a ProfileEntryEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerLookup()} is {@code true} .

    • getProfileEntryEnablerLookupSessionForProfile

      ProfileEntryEnablerLookupSession getProfileEntryEnablerLookupSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the profile entry enabler lookup service for the given profile.
      Parameters:
      profileId - the Id of the Profile
      Returns:
      a ProfileEntryEnablerLookupSession
      Throws:
      NotFoundException - no Profile found by the given Id
      NullArgumentException - profileId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProfileEntryEnablerQuerySession

      ProfileEntryEnablerQuerySession getProfileEntryEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the profile entry enabler query service.
      Returns:
      a ProfileEntryEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerQuery()} is {@code true} .

    • getProfileEntryEnablerQuerySessionForProfile

      ProfileEntryEnablerQuerySession getProfileEntryEnablerQuerySessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the profile entry enabler query service for the given profile.
      Parameters:
      profileId - the Id of the Profile
      Returns:
      a ProfileEntryEnablerQuerySession
      Throws:
      NotFoundException - no Profile found by the given Id
      NullArgumentException - profileId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProfileEntryEnablerSearchSession

      ProfileEntryEnablerSearchSession getProfileEntryEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the profile entry enabler search service.
      Returns:
      a ProfileEntryEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerSearch()} is {@code true} .

    • getProfileEntryEnablerSearchSessionForProfile

      ProfileEntryEnablerSearchSession getProfileEntryEnablerSearchSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the profile entry enablers earch service for the given profile.
      Parameters:
      profileId - the Id of the Profile
      Returns:
      a ProfileEntryEnablerSearchSession
      Throws:
      NotFoundException - no Profile found by the given Id
      NullArgumentException - profileId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProfileEntryEnablerAdminSession

      ProfileEntryEnablerAdminSession getProfileEntryEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the profile entry enabler administration service.
      Returns:
      a ProfileEntryEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerAdmin()} is {@code true} .

    • getProfileEntryEnablerAdminSessionForProfile

      ProfileEntryEnablerAdminSession getProfileEntryEnablerAdminSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the profile entry enabler administration service for the given profile.
      Parameters:
      profileId - the Id of the Profile
      Returns:
      a ProfileEntryEnablerAdminSession
      Throws:
      NotFoundException - no Profile found by the given Id
      NullArgumentException - profileId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProfileEntryEnablerNotificationSession

      ProfileEntryEnablerNotificationSession getProfileEntryEnablerNotificationSession(ProfileEntryEnablerReceiver profileEntryEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the profile entry enabler notification service.
      Parameters:
      profileEntryEnablerReceiver - the notification callback
      Returns:
      a ProfileEntryEnablerNotificationSession
      Throws:
      NullArgumentException - profileEntryEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerNotification()} is {@code true} .

    • getProfileEntryEnablerNotificationSessionForProfile

      ProfileEntryEnablerNotificationSession getProfileEntryEnablerNotificationSessionForProfile(ProfileEntryEnablerReceiver profileEntryEnablerReceiver, Id profileId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the profile entry enabler notification service for the given profile.
      Parameters:
      profileEntryEnablerReceiver - the notification callback
      profileId - the Id of the Profile
      Returns:
      a ProfileEntryEnablerNotificationSession
      Throws:
      NotFoundException - no profile found by the given Id
      NullArgumentException - profileEntryEnablerReceiver or profileId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProfileEntryEnablerProfileSession

      ProfileEntryEnablerProfileSession getProfileEntryEnablerProfileSession() throws OperationFailedException
      Gets the OsidSession to lookup profile entry enabler/profile mappings for profile entry enablers.
      Returns:
      a ProfileEntryEnablerProfileSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerProfile() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerProfile()} is {@code true} .

    • getProfileEntryEnablerProfileAssignmentSession

      ProfileEntryEnablerProfileAssignmentSession getProfileEntryEnablerProfileAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning profile entry enablers to profiles for profile entry.
      Returns:
      a ProfileEntryEnablerProfileAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerProfileAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerProfileAssignment()} is {@code true} .

    • getProfileEntryEnablerSmartProfileSession

      ProfileEntryEnablerSmartProfileSession getProfileEntryEnablerSmartProfileSession(Id profileId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage profile entry enabler smart profiles.
      Parameters:
      profileId - the Id of the Profile
      Returns:
      a ProfileEntryEnablerSmartProfileSession
      Throws:
      NotFoundException - no Profile found by the given Id
      NullArgumentException - profileId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerSmartProfile() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerSmartProfile()} is {@code true} .

    • getProfileEntryEnablerRuleLookupSession

      ProfileEntryEnablerRuleLookupSession getProfileEntryEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the profile entry enabler mapping lookup service for looking up the rules applied to a profile entry.
      Returns:
      a ProfileEntryEnablerRuleSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerRuleLookup()} is {@code true} .

    • getProfileEntryEnablerRuleLookupSessionForProfile

      ProfileEntryEnablerRuleLookupSession getProfileEntryEnablerRuleLookupSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the profile entry enabler mapping lookup service for the given profile for looking up rules applied to a profile entry.
      Parameters:
      profileId - the Id of the Profile
      Returns:
      a ProfileEntryEnablerRuleLookupSession
      Throws:
      NotFoundException - no Profile found by the given Id
      NullArgumentException - profileId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProfileEntryEnablerRuleApplicationSession

      ProfileEntryEnablerRuleApplicationSession getProfileEntryEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the profile entry enabler assignment service to apply enablers to profile entries.
      Returns:
      a ProfileEntryEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerRuleApplication()} is {@code true} .

    • getProfileEntryEnablerRuleApplicationSessionForProfile

      ProfileEntryEnablerRuleApplicationSession getProfileEntryEnablerRuleApplicationSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the profile entry enabler assignment service for the given profile to apply enablers to profile entries.
      Parameters:
      profileId - the Id of the Profile
      Returns:
      a ProfileEntryEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Profile found by the given Id
      NullArgumentException - profileId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProfileEntryEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProfileEntryEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .