Interface HoldProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
HoldManager, HoldProxyManager
public interface HoldProfile extends OsidProfile

The hold profile describes the interoperability among hold services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any oubliette federation is exposed. Federation is exposed when a specific oubliette may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of oubliettes appears as a single oubliette.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlocking

      boolean supportsBlocking()
      Tests if a blocking service is supported for the current agent.
      Returns:
      true if blockiings service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMyHold

      boolean supportsMyHold()
      Tests if a my hold service is supported for the current agent.
      Returns:
      true if my hold service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockLookup

      boolean supportsBlockLookup()
      Tests if looking up blocks is supported.
      Returns:
      true if block lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockQuery

      boolean supportsBlockQuery()
      Tests if querying blocks is supported.
      Returns:
      true if block query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockSearch

      boolean supportsBlockSearch()
      Tests if searching blocks is supported.
      Returns:
      true if block search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockAdmin

      boolean supportsBlockAdmin()
      Tests if block administrative service is supported.
      Returns:
      true if block administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockNotification

      boolean supportsBlockNotification()
      Tests if a block notification service is supported.
      Returns:
      true if block notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockOubliette

      boolean supportsBlockOubliette()
      Tests if a block oubliette lookup service is supported.
      Returns:
      true if a block oubliette lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockOublietteAssignment

      boolean supportsBlockOublietteAssignment()
      Tests if a block oubliette service is supported.
      Returns:
      true if block to oubliette assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockSmartOubliette

      boolean supportsBlockSmartOubliette()
      Tests if a block smart oubliette lookup service is supported.
      Returns:
      true if a block smart oubliette service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueLookup

      boolean supportsIssueLookup()
      Tests if looking up issues is supported.
      Returns:
      true if issue lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueQuery

      boolean supportsIssueQuery()
      Tests if querying issues is supported.
      Returns:
      true if issue query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueSearch

      boolean supportsIssueSearch()
      Tests if searching issues is supported.
      Returns:
      true if issue search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueAdmin

      boolean supportsIssueAdmin()
      Tests if issue administrative service is supported.
      Returns:
      true if issue administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueNotification

      boolean supportsIssueNotification()
      Tests if an issue notification service is supported.
      Returns:
      true if issue notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueOubliette

      boolean supportsIssueOubliette()
      Tests if an issue oubliette lookup service is supported.
      Returns:
      true if an issue oubliette lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueOublietteAssignment

      boolean supportsIssueOublietteAssignment()
      Tests if an issue oubliette assignment service is supported.
      Returns:
      true if an issue to oubliette assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueSmartOubliette

      boolean supportsIssueSmartOubliette()
      Tests if an issue smart oubliette service is supported.
      Returns:
      true if an issue smart oubliette service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldLookup

      boolean supportsHoldLookup()
      Tests if looking up holds is supported.
      Returns:
      true if hold lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldQuery

      boolean supportsHoldQuery()
      Tests if querying holds is supported.
      Returns:
      true if hold query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldSearch

      boolean supportsHoldSearch()
      Tests if searching holds is supported.
      Returns:
      true if hold search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldAdmin

      boolean supportsHoldAdmin()
      Tests if hold administrative service is supported.
      Returns:
      true if hold administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldNotification

      boolean supportsHoldNotification()
      Tests if a hold notification service is supported.
      Returns:
      true if hold notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldOubliette

      boolean supportsHoldOubliette()
      Tests if a hold oubliette lookup service is supported.
      Returns:
      true if a hold oubliette lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldOublietteAssignment

      boolean supportsHoldOublietteAssignment()
      Tests if a hold oubliette service is supported.
      Returns:
      true if hold to oubliette assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldSmartOubliette

      boolean supportsHoldSmartOubliette()
      Tests if a hold smart oubliette lookup service is supported.
      Returns:
      true if a hold smart oubliette service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOublietteLookup

      boolean supportsOublietteLookup()
      Tests if looking up oubliettes is supported.
      Returns:
      true if oubliette lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOublietteQuery

      boolean supportsOublietteQuery()
      Tests if querying oubliettes is supported.
      Returns:
      true if an oubliette query service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOublietteSearch

      boolean supportsOublietteSearch()
      Tests if searching oubliettes is supported.
      Returns:
      true if oubliette search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOublietteAdmin

      boolean supportsOublietteAdmin()
      Tests if oubliette administrative service is supported.
      Returns:
      true if oubliette administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOublietteNotification

      boolean supportsOublietteNotification()
      Tests if an oubliette notification service is supported.
      Returns:
      true if oubliette notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOublietteHierarchy

      boolean supportsOublietteHierarchy()
      Tests for the availability of an oubliette hierarchy traversal service.
      Returns:
      true if oubliette hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsOublietteHierarchyDesign

      boolean supportsOublietteHierarchyDesign()
      Tests for the availability of an oubliette hierarchy design service.
      Returns:
      true if oubliette hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldBatch

      boolean supportsHoldBatch()
      Tests for the availability of a hold batch service.
      Returns:
      true if a hold batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldRules

      boolean supportsHoldRules()
      Tests for the availability of a hold rules service.
      Returns:
      true if a hold rules service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBlockRecordTypes

      TypeList getBlockRecordTypes()
      Gets the supported Block record types.
      Returns:
      a list containing the supported Block record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockRecordType

      boolean supportsBlockRecordType(Type blockRecordType)
      Tests if the given Block record type is supported.
      Parameters:
      blockRecordType - a Type indicating a Block record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - blockRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getBlockSearchRecordTypes

      TypeList getBlockSearchRecordTypes()
      Gets the supported Block search record types.
      Returns:
      a list containing the supported Block search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockSearchRecordType

      boolean supportsBlockSearchRecordType(Type blockSearchRecordType)
      Tests if the given Block search record type is supported.
      Parameters:
      blockSearchRecordType - a Type indicating a Block search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - blockSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getIssueRecordTypes

      TypeList getIssueRecordTypes()
      Gets the supported Issue record types.
      Returns:
      a list containing the supported Issue record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueRecordType

      boolean supportsIssueRecordType(Type issueRecordType)
      Tests if the given Issue record type is supported.
      Parameters:
      issueRecordType - a Type indicating an Issue record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - issueRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getIssueSearchRecordTypes

      TypeList getIssueSearchRecordTypes()
      Gets the supported Issue search types.
      Returns:
      a list containing the supported Issue search types
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueSearchRecordType

      boolean supportsIssueSearchRecordType(Type issueSearchRecordType)
      Tests if the given Issue search type is supported.
      Parameters:
      issueSearchRecordType - a Type indicating an Issue search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - issueSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getHoldRecordTypes

      TypeList getHoldRecordTypes()
      Gets the supported Hold record types.
      Returns:
      a list containing the supported Hold record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldRecordType

      boolean supportsHoldRecordType(Type holdRecordType)
      Tests if the given Hold record type is supported.
      Parameters:
      holdRecordType - a Type indicating a Hold record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - holdRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getHoldSearchRecordTypes

      TypeList getHoldSearchRecordTypes()
      Gets the supported Hold search record types.
      Returns:
      a list containing the supported Hold search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldSearchRecordType

      boolean supportsHoldSearchRecordType(Type holdSearchRecordType)
      Tests if the given Hold search record type is supported.
      Parameters:
      holdSearchRecordType - a Type indicating a Hold search record type
      Returns:
      true if the given search record type is supported, false otherwise
      Throws:
      NullArgumentException - holdSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getOublietteRecordTypes

      TypeList getOublietteRecordTypes()
      Gets the supported Oubliette record types.
      Returns:
      a list containing the supported Oubliette types
      Compliance:
      mandatory - This method must be implemented.

    • supportsOublietteRecordType

      boolean supportsOublietteRecordType(Type oublietteRecordType)
      Tests if the given Oubliette record type is supported.
      Parameters:
      oublietteRecordType - a Type indicating an Oubliette record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - oublietteRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getOublietteSearchRecordTypes

      TypeList getOublietteSearchRecordTypes()
      Gets the supported Oubliette search types.
      Returns:
      a list containing the supported Oubliette search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsOublietteSearchRecordType

      boolean supportsOublietteSearchRecordType(Type oublietteSearchRecordType)
      Tests if the given Oubliette search record type is supported.
      Parameters:
      oublietteSearchRecordType - a Type indicating an Oubliette search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - oublietteSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.