OSID - osid.hold.HoldProfile Service Interface Definition

Interface	osid.hold.HoldProfile
Implements	`osid.OsidProfile`
Description	The hold profile describes the interoperability among hold services.
Method	supportsVisibleFederation
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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlocking
Description	Tests if a blocking service is supported for the current agent.
Return	`boolean`		`true` if blockiings service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMyHold
Description	Tests if a my hold service is supported for the current agent.
Return	`boolean`		`true` if my hold service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockLookup
Description	Tests if looking up blocks is supported.
Return	`boolean`		`true` if block lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockQuery
Description	Tests if querying blocks is supported.
Return	`boolean`		`true` if block query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockSearch
Description	Tests if searching blocks is supported.
Return	`boolean`		`true` if block search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockAdmin
Description	Tests if block administrative service is supported.
Return	`boolean`		`true` if block administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockNotification
Description	Tests if a block notification service is supported.
Return	`boolean`		`true` if block notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockOubliette
Description	Tests if a block oubliette lookup service is supported.
Return	`boolean`		`true` if a block oubliette lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockOublietteAssignment
Description	Tests if a block oubliette service is supported.
Return	`boolean`		`true` if block to oubliette assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockSmartOubliette
Description	Tests if a block smart oubliette lookup service is supported.
Return	`boolean`		`true` if a block smart oubliette service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueLookup
Description	Tests if looking up issues is supported.
Return	`boolean`		`true` if issue lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueQuery
Description	Tests if querying issues is supported.
Return	`boolean`		`true` if issue query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueSearch
Description	Tests if searching issues is supported.
Return	`boolean`		`true` if issue search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueAdmin
Description	Tests if issue administrative service is supported.
Return	`boolean`		`true` if issue administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueNotification
Description	Tests if an issue notification service is supported.
Return	`boolean`		`true` if issue notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueOubliette
Description	Tests if an issue oubliette lookup service is supported.
Return	`boolean`		`true` if an issue oubliette lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueOublietteAssignment
Description	Tests if an issue oubliette assignment service is supported.
Return	`boolean`		`true` if an issue to oubliette assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueSmartOubliette
Description	Tests if an issue smart oubliette service is supported.
Return	`boolean`		`true` if an issue smart oubliette service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldLookup
Description	Tests if looking up holds is supported.
Return	`boolean`		`true` if hold lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldQuery
Description	Tests if querying holds is supported.
Return	`boolean`		`true` if hold query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldSearch
Description	Tests if searching holds is supported.
Return	`boolean`		`true` if hold search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldAdmin
Description	Tests if hold administrative service is supported.
Return	`boolean`		`true` if hold administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldNotification
Description	Tests if a hold notification service is supported.
Return	`boolean`		`true` if hold notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldOubliette
Description	Tests if a hold oubliette lookup service is supported.
Return	`boolean`		`true` if a hold oubliette lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldOublietteAssignment
Description	Tests if a hold oubliette service is supported.
Return	`boolean`		`true` if hold to oubliette assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldSmartOubliette
Description	Tests if a hold smart oubliette lookup service is supported.
Return	`boolean`		`true` if a hold smart oubliette service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOublietteLookup
Description	Tests if looking up oubliettes is supported.
Return	`boolean`		`true` if oubliette lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOublietteQuery
Description	Tests if querying oubliettes is supported.
Return	`boolean`		`true` if an oubliette query service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOublietteSearch
Description	Tests if searching oubliettes is supported.
Return	`boolean`		`true` if oubliette search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOublietteAdmin
Description	Tests if oubliette administrative service is supported.
Return	`boolean`		`true` if oubliette administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOublietteNotification
Description	Tests if an oubliette notification service is supported.
Return	`boolean`		`true` if oubliette notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOublietteHierarchy
Description	Tests for the availability of an oubliette hierarchy traversal service.
Return	`boolean`		`true` if oubliette hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsOublietteHierarchyDesign
Description	Tests for the availability of an oubliette hierarchy design service.
Return	`boolean`		`true` if oubliette hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldBatch
Description	Tests for the availability of a hold batch service.
Return	`boolean`		`true` if a hold batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldRules
Description	Tests for the availability of a hold rules service.
Return	`boolean`		`true` if a hold rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBlockRecordTypes
Description	Gets the supported `Block` record types.
Return	`osid.type.TypeList`		a list containing the supported `Block` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockRecordType
Description	Tests if the given `Block` record type is supported.
Parameters	`osid.type.Type`	`blockRecordType`	a `Type` indicating a `Block` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`blockRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBlockSearchRecordTypes
Description	Gets the supported `Block` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Block` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockSearchRecordType
Description	Tests if the given `Block` search record type is supported.
Parameters	`osid.type.Type`	`blockSearchRecordType`	a `Type` indicating a `Block` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`blockSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIssueRecordTypes
Description	Gets the supported `Issue` record types.
Return	`osid.type.TypeList`		a list containing the supported `Issue` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueRecordType
Description	Tests if the given `Issue` record type is supported.
Parameters	`osid.type.Type`	`issueRecordType`	a `Type` indicating an `Issue` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`issueRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIssueSearchRecordTypes
Description	Gets the supported `Issue` search types.
Return	`osid.type.TypeList`		a list containing the supported `Issue` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueSearchRecordType
Description	Tests if the given `Issue` search type is supported.
Parameters	`osid.type.Type`	`issueSearchRecordType`	a `Type` indicating an `Issue` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`issueSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getHoldRecordTypes
Description	Gets the supported `Hold` record types.
Return	`osid.type.TypeList`		a list containing the supported `Hold` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldRecordType
Description	Tests if the given `Hold` record type is supported.
Parameters	`osid.type.Type`	`holdRecordType`	a `Type` indicating a `Hold` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`holdRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getHoldSearchRecordTypes
Description	Gets the supported `Hold` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Hold` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldSearchRecordType
Description	Tests if the given `Hold` search record type is supported.
Parameters	`osid.type.Type`	`holdSearchRecordType`	a `Type` indicating a `Hold` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`holdSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteRecordTypes
Description	Gets the supported `Oubliette` record types.
Return	`osid.type.TypeList`		a list containing the supported `Oubliette` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsOublietteRecordType
Description	Tests if the given `Oubliette` record type is supported.
Parameters	`osid.type.Type`	`oublietteRecordType`	a `Type` indicating a `Oubliette` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`oublietteRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteSearchRecordTypes
Description	Gets the supported `Oubliette` search types.
Return	`osid.type.TypeList`		a list containing the supported `Oubliette` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsOublietteSearchRecordType
Description	Tests if the given `Oubliette` search record type is supported.
Parameters	`osid.type.Type`	`oublietteSearchRecordType`	a `Type` indicating a `Oubliette` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`oublietteSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.