Interface ProcessConstrainerLookupSession

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

This session provides methods for retrieving ProcessConstrainers .

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 methods in this session operate, retrieve and pertain to process constrainers defined explicitly in the current office Using an isolated view is useful for managing ProcessConstrainers with the ProcessConstrainerAdminSession .
  • federated office view: All process constrainer methods in this session operate, retrieve and pertain to all process constrainers defined in this office and any other process constrainers 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.

    • canLookupProcessConstrainers

      boolean canLookupProcessConstrainers()
      Tests if this user can perform ProcessConstrainer 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.

    • useComparativeProcessConstrainerView

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

    • usePlenaryProcessConstrainerView

      void usePlenaryProcessConstrainerView()
      A complete view of the ProcessConstrainer 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 constrainers 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.

    • getProcessConstrainer

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

    • getProcessConstrainersByIds

      ProcessConstrainerList getProcessConstrainersByIds(IdList processConstrainerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a ProcessConstrainerList corresponding to the given IdList . In plenary mode, the returned list contains all of the process constrainers 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 ProcessConstrainers may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      processConstrainerIds - the list of Ids to retrieve
      Returns:
      the returned ProcessConstrainer list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - processConstrainerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainersByGenusType

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

    • getProcessConstrainersByParentGenusType

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

    • getProcessConstrainersByRecordType

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

    • getProcessConstrainers

      ProcessConstrainerList getProcessConstrainers() throws OperationFailedException, PermissionDeniedException
      Gets all ProcessConstrainers . In ple nary mode, the returned list contains all known process constrainers or an error results. Otherwise, the returned list may contain only those process constrainers that are accessible through this session.
      Returns:
      a list of ProcessConstrainers
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.