OSID - osid.sequencing.SequencingProfile Service Interface Definition

Interface	osid.sequencing.SequencingProfile
Implements	`osid.OsidProfile`
Description	The sequencing profile describes the interoperability among sequencing services.
Method	supportsVisibleFederation
Description	Tests if any action group federation is exposed. Federation is exposed when a specific action group may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of action groups appears as a single action group.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsElementLookup
Description	Tests if looking up elements is supported.
Return	`boolean`		`true` if element lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsElementAdmin
Description	Tests if managing elements is supported.
Return	`boolean`		`true` if element management is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSequencing
Description	Tests if sequencing elements is supported.
Return	`boolean`		`true` if element sequencing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChainLookup
Description	Tests if looking up chains is supported.
Return	`boolean`		`true` if chain lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChainQuery
Description	Tests if querying chains is supported.
Return	`boolean`		`true` if chain query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChainSearch
Description	Tests if searching chains is supported.
Return	`boolean`		`true` if chain search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChainAdmin
Description	Tests if chain administrative service is supported.
Return	`boolean`		`true` if chain administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChainNotification
Description	Tests if a chain notification service is supported.
Return	`boolean`		`true` if chain notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChainAntimatroid
Description	Tests if a chain antimatroid lookup service is supported.
Return	`boolean`		`true` if a chain antimatroid lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChainAntimatroidAssignment
Description	Tests if a chain antimatroid assignment service is supported.
Return	`boolean`		`true` if a chain to antimatroid assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsChainSmartAntimatroid
Description	Tests if a chain smart antimatroid service is supported.
Return	`boolean`		`true` if a chain smart antimatroid service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAntimatroidLookup
Description	Tests if looking up antimatroids is supported.
Return	`boolean`		`true` if antimatroid lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAntimatroidQuery
Description	Tests if querying antimatroids is supported.
Return	`boolean`		`true` if an antimatroid query service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAntimatroidSearch
Description	Tests if searching antimatroids is supported.
Return	`boolean`		`true` if antimatroid search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAntimatroidAdmin
Description	Tests if antimatroid administrative service is supported.
Return	`boolean`		`true` if antimatroid administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAntimatroidNotification
Description	Tests if an antimatroid notification service is supported.
Return	`boolean`		`true` if antimatroid notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAntimatroidHierarchy
Description	Tests for the availability of an antimatroid hierarchy traversal service.
Return	`boolean`		`true` if antimatroid hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsAntimatroidHierarchyDesign
Description	Tests for the availability of an antimatroid hierarchy design service.
Return	`boolean`		`true` if antimatroid hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getChainRecordTypes
Description	Gets the supported `Chain` record types.
Return	`osid.type.TypeList`		a list containing the supported `Chain` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsChainRecordType
Description	Tests if the given `Chain` record type is supported.
Parameters	`osid.type.Type`	`chainRecordType`	a `Type` indicating a `Chain` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`chainRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getChainSearchRecordTypes
Description	Gets the supported `Chain` search types.
Return	`osid.type.TypeList`		a list containing the supported `Chain` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsChainSearchRecordType
Description	Tests if the given `Chain` search type is supported.
Parameters	`osid.type.Type`	`chainSearchRecordType`	a `Type` indicating a `Chain` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`chainSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroidRecordTypes
Description	Gets the supported `Antimatroid` record types.
Return	`osid.type.TypeList`		a list containing the supported `Antimatroid` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAntimatroidRecordType
Description	Tests if the given `Antimatroid` record type is supported.
Parameters	`osid.type.Type`	`antimatroidRecordType`	a `Type` indicating an `Antimatroid` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`antimatroidRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroidSearchRecordTypes
Description	Gets the supported `Antimatroid` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Antimatroid` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAntimatroidSearchRecordType
Description	Tests if the given `Antimatroid` search record type is supported.
Parameters	`osid.type.Type`	`antimatroidSearchRecordType`	a `Type` indicating an `Antimatroid` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`antimatroidSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.