OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.HoldProfile
Implementsosid.OsidProfile
Description

The hold profile describes the interoperability among hold services.

MethodsupportsVisibleFederation
Description

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.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBlocking
Description

Tests if a blocking service is supported for the current agent.

Returnboolean true if blockiings service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMyHold
Description

Tests if a my hold service is supported for the current agent.

Returnboolean true if my hold service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBlockLookup
Description

Tests if looking up blocks is supported.

Returnboolean true if block lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBlockQuery
Description

Tests if querying blocks is supported.

Returnboolean true if block query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBlockSearch
Description

Tests if searching blocks is supported.

Returnboolean true if block search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBlockAdmin
Description

Tests if block administrative service is supported.

Returnboolean true if block administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBlockNotification
Description

Tests if a block notification service is supported.

Returnboolean true if block notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBlockOubliette
Description

Tests if a block oubliette lookup service is supported.

Returnboolean true if a block oubliette lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBlockOublietteAssignment
Description

Tests if a block oubliette service is supported.

Returnboolean true if block to oubliette assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBlockSmartOubliette
Description

Tests if a block smart oubliette lookup service is supported.

Returnboolean true if a block smart oubliette service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIssueLookup
Description

Tests if looking up issues is supported.

Returnboolean true if issue lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIssueQuery
Description

Tests if querying issues is supported.

Returnboolean true if issue query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIssueSearch
Description

Tests if searching issues is supported.

Returnboolean true if issue search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIssueAdmin
Description

Tests if issue administrative service is supported.

Returnboolean true if issue administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIssueNotification
Description

Tests if an issue notification service is supported.

Returnboolean true if issue notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIssueOubliette
Description

Tests if an issue oubliette lookup service is supported.

Returnboolean true if an issue oubliette lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIssueOublietteAssignment
Description

Tests if an issue oubliette assignment service is supported.

Returnboolean true if an issue to oubliette assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIssueSmartOubliette
Description

Tests if an issue smart oubliette service is supported.

Returnboolean true if an issue smart oubliette service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldLookup
Description

Tests if looking up holds is supported.

Returnboolean true if hold lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldQuery
Description

Tests if querying holds is supported.

Returnboolean true if hold query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldSearch
Description

Tests if searching holds is supported.

Returnboolean true if hold search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldAdmin
Description

Tests if hold administrative service is supported.

Returnboolean true if hold administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldNotification
Description

Tests if a hold notification service is supported.

Returnboolean true if hold notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldOubliette
Description

Tests if a hold oubliette lookup service is supported.

Returnboolean true if a hold oubliette lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldOublietteAssignment
Description

Tests if a hold oubliette service is supported.

Returnboolean true if hold to oubliette assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldSmartOubliette
Description

Tests if a hold smart oubliette lookup service is supported.

Returnboolean true if a hold smart oubliette service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOublietteLookup
Description

Tests if looking up oubliettes is supported.

Returnboolean true if oubliette lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOublietteQuery
Description

Tests if querying oubliettes is supported.

Returnboolean true if an oubliette query service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOublietteSearch
Description

Tests if searching oubliettes is supported.

Returnboolean true if oubliette search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOublietteAdmin
Description

Tests if oubliette administrative service is supported.

Returnboolean true if oubliette administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOublietteNotification
Description

Tests if an oubliette notification service is supported.

Returnboolean true if oubliette notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOublietteHierarchy
Description

Tests for the availability of an oubliette hierarchy traversal service.

Returnboolean true if oubliette hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsOublietteHierarchyDesign
Description

Tests for the availability of an oubliette hierarchy design service.

Returnboolean true if oubliette hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldBatch
Description

Tests for the availability of a hold batch service.

Returnboolean true if a hold batch service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldRules
Description

Tests for the availability of a hold rules service.

Returnboolean true if a hold rules service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBlockRecordTypes
Description

Gets the supported Block record types.

Returnosid.type.TypeLista list containing the supported Block record types
CompliancemandatoryThis method must be implemented.
MethodsupportsBlockRecordType
Description

Tests if the given Block record type is supported.

Parametersosid.type.TypeblockRecordTypea Type indicating a Block record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT blockRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetBlockSearchRecordTypes
Description

Gets the supported Block search record types.

Returnosid.type.TypeLista list containing the supported Block search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsBlockSearchRecordType
Description

Tests if the given Block search record type is supported.

Parametersosid.type.TypeblockSearchRecordTypea Type indicating a Block search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT blockSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetIssueRecordTypes
Description

Gets the supported Issue record types.

Returnosid.type.TypeLista list containing the supported Issue record types
CompliancemandatoryThis method must be implemented.
MethodsupportsIssueRecordType
Description

Tests if the given Issue record type is supported.

Parametersosid.type.TypeissueRecordTypea Type indicating an Issue record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT issueRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetIssueSearchRecordTypes
Description

Gets the supported Issue search types.

Returnosid.type.TypeLista list containing the supported Issue search types
CompliancemandatoryThis method must be implemented.
MethodsupportsIssueSearchRecordType
Description

Tests if the given Issue search type is supported.

Parametersosid.type.TypeissueSearchRecordTypea Type indicating an Issue search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT issueSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetHoldRecordTypes
Description

Gets the supported Hold record types.

Returnosid.type.TypeLista list containing the supported Hold record types
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldRecordType
Description

Tests if the given Hold record type is supported.

Parametersosid.type.TypeholdRecordTypea Type indicating a Hold record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT holdRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetHoldSearchRecordTypes
Description

Gets the supported Hold search record types.

Returnosid.type.TypeLista list containing the supported Hold search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldSearchRecordType
Description

Tests if the given Hold search record type is supported.

Parametersosid.type.TypeholdSearchRecordTypea Type indicating a Hold search record type
Returnboolean true if the given search record type is supported, false otherwise
ErrorsNULL_ARGUMENT holdSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetOublietteRecordTypes
Description

Gets the supported Oubliette record types.

Returnosid.type.TypeLista list containing the supported Oubliette types
CompliancemandatoryThis method must be implemented.
MethodsupportsOublietteRecordType
Description

Tests if the given Oubliette record type is supported.

Parametersosid.type.TypeoublietteRecordTypea Type indicating a Oubliette record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT oublietteRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetOublietteSearchRecordTypes
Description

Gets the supported Oubliette search types.

Returnosid.type.TypeLista list containing the supported Oubliette search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsOublietteSearchRecordType
Description

Tests if the given Oubliette search record type is supported.

Parametersosid.type.TypeoublietteSearchRecordTypea Type indicating a Oubliette search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT oublietteSearchRecordType is null
CompliancemandatoryThis method must be implemented.