Interface ProcessConstrainerEnablerLookupSession

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

This session provides methods for retrieving ProcessConstrainerEnablers .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated office view: All process cosntrainer enabler methods in this session operate, retrieve and pertain to process constrainer enablers defined explicitly in the current office Using an isolated view is useful for managing ProcessConstrainerEnablers with the ProcessConstrainerEnablerAdminSession .
  • federated office view: All process constrainer enabler methods in this session operate, retrieve and pertain to all process constrainer enablers defined in this office and any other process constrainer enablers implicitly available in this office through office inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedOfficeView() and useIsolatedOfficeView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getOfficeId

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

    • getOffice

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

    • canLookupProcessConstrainerEnablers

      boolean canLookupProcessConstrainerEnablers()
      Tests if this user can perform ProcessConstrainerEnabler lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeProcessConstrainerEnablerView

      void useComparativeProcessConstrainerEnablerView()
      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.

    • usePlenaryProcessConstrainerEnablerView

      void usePlenaryProcessConstrainerEnablerView()
      A complete view of the ProcessConstrainerEnabler 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.

    • useFederatedOfficeView

      void useFederatedOfficeView()
      Federates the view for methods in this session. A federated view will include process constrainer enablers in offices which are children of this office in the office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOfficeView

      void useIsolatedOfficeView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this office only.
      Compliance:
      mandatory - This method is must be implemented.

    • getProcessConstrainerEnabler

      ProcessConstrainerEnabler getProcessConstrainerEnabler(Id processConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessConstrainerEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ProcessConstrainerEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a ProcessConstrainerEnabler and re tained for compatibility.
      Parameters:
      processConstrainerEnablerId - Id of the ProcessConstrainerEnabler
      Returns:
      the process constrainer enabler
      Throws:
      NotFoundException - processConstrainerEnablerId not found
      NullArgumentException - processConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getProcessConstrainerEnablersByIds

      ProcessConstrainerEnablerList getProcessConstrainerEnablersByIds(IdList processConstrainerEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a ProcessConstrainerEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the process constrainer enablers specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible ProcessConstrainerEnablers may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      processConstrainerEnablerIds - the list of Ids to retrieve
      Returns:
      the returned ProcessConstrainerEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - processConstrainerEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerEnablersByGenusType

      ProcessConstrainerEnablerList getProcessConstrainerEnablersByGenusType(Type processConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a ProcessConstrainerEnablerList corresponding to the given process constrainer enabler genus Type which does not include process constrainer enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known process constrainer enablers or an error results. Otherwise, the returned list may contain only those process constrainer enablers that are accessible through this session.
      Parameters:
      processConstrainerEnablerGenusType - a process constrainer enabler genus type
      Returns:
      the returned ProcessConstrainerEnabler list
      Throws:
      NullArgumentException - processConstrainerEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerEnablersByParentGenusType

      ProcessEnablerList getProcessConstrainerEnablersByParentGenusType(Type processConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a ProcessConstrainerEnablerList corresponding to the given process constrainer enabler genus Type and include any additional process constrainer enablers with genus types derived from the specified Type . In plenary mode, the returned list contains all known process constrainer enablers or an error results. Otherwise, the returned list may contain only those process constrainer enablers that are accessible through this session.
      Parameters:
      processConstrainerEnablerGenusType - a process constrainer genus type
      Returns:
      the returned ProcessConstrainerEnabler list
      Throws:
      NullArgumentException - processConstrainerEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerEnablersByRecordType

      ProcessConstrainerEnablerList getProcessConstrainerEnablersByRecordType(Type processConstrainerEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a ProcessConstrainerEnablerList containing the given process constrainer enabler record Type . In plenary mode, the returned list contains all known process constrainer enablers or an error results. Otherwise, the returned list may contain only those process constrainer enablers that are accessible through this session.
      Parameters:
      processConstrainerEnablerRecordType - a process constrainer enabler record type
      Returns:
      the returned ProcessConstrainerEnabler list
      Throws:
      NullArgumentException - processConstrainerEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerEnablers

      ProcessConstrainerEnablerList getProcessConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all ProcessConstrainerEnablers . In plen ary mode, the returned list contains all known process constrainer enablers or an error results. Otherwise, the returned list may contain only those process constrainer enablers that are accessible through this session.
      Returns:
      a list of ProcessConstrainerEnablers
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.