OSID - osid.resource.ResourceProfile Service Interface Definition

Interface	osid.resource.ResourceProfile
Implements	`osid.OsidProfile`
Description	The resource profile describes interoperability among resource services.
Method	supportsVisibleFederation
Description	Tests if federation is visible.
Return	`boolean`		`true` if visible federation is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceLookup
Description	Tests if resource lookup is supported.
Return	`boolean`		`true` if resource lookup is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
Description	Tests if resource query is supported.
Return	`boolean`		`true` if resource query is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceSearch
Description	Tests if resource search is supported.
Return	`boolean`		`true` if resource search is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceAdmin
Description	Tests if resource administration is supported.
Return	`boolean`		`true` if resource administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceNotification
Description	Tests if resource notification is supported. Messages may be sent when resources are created, modified, or deleted.
Return	`boolean`		`true` if resource notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceBin
Description	Tests if retrieving mappings of resource and bins is supported.
Return	`boolean`		`true` if resource bin mapping retrieval is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceBinAssignment
Description	Tests if managing mappings of resource and bins is supported.
Return	`boolean`		`true` if resource bin assignment is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceSmartBin
Description	Tests if resource smart bins are available.
Return	`boolean`		`true` if resource smart bins are supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMembership
Description	Tests if membership queries are supported.
Return	`boolean`		`true` if membership queries are supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGroup
Description	Tests if group resources are supported.
Return	`boolean`		`true` if group resources are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGroupAssignment
Description	Tests if group resource assignment is supported.
Return	`boolean`		`true` if group resource assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGroupNotification
Description	Tests if group resource notification is supported.
Return	`boolean`		`true` if group resource notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGroupHierarchy
Description	Tests if a group resource hierarchy service is supported.
Return	`boolean`		`true` if group resource hierarchy is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceAgent
Description	Tests if retrieving mappings of resource and agents is supported.
Return	`boolean`		`true` if resource agent mapping retrieval is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceAgentAssignment
Description	Tests if managing mappings of resources and agents is supported.
Return	`boolean`		`true` if resource agent assignment is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipLookup
Description	Tests if looking up resource relationships is supported.
Return	`boolean`		`true` if resource relationships lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipQuery
Description	Tests if querying resource relationships is supported.
Return	`boolean`		`true` if resource relationships query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipSearch
Description	Tests if searching resource relationships is supported.
Return	`boolean`		`true` if resource relationships search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipAdmin
Description	Tests if a resource relationships administrative service is supported.
Return	`boolean`		`true` if resource relationships administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipNotification
Description	Tests if a resource relationships notification service is supported.
Return	`boolean`		`true` if resource relationships notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipBin
Description	Tests if retrieving mappings of resource relationships and bins is supported.
Return	`boolean`		`true` if resource relationship bin mapping retrieval is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipBinAssignment
Description	Tests if managing mappings of resource relationships and bins is supported.
Return	`boolean`		`true` if resource relationship bin assignment is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipSmartBin
Description	Tests if resource relationship smart bins are available.
Return	`boolean`		`true` if resource relationship smart bins are supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinLookup
Description	Tests if bin lookup is supported.
Return	`boolean`		`true` if bin lookup is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinQuery
Description	Tests if bin query is supported.
Return	`boolean`		`true` if bin query is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinSearch
Description	Tests if bin search is supported.
Return	`boolean`		`true` if bin search is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinAdmin
Description	Tests if bin administration is supported.
Return	`boolean`		`true` if bin administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinNotification
Description	Tests if bin notification is supported. Messages may be sent when `Bin` objects are created, deleted or updated. Notifications for resources within bins are sent via the resource notification session.
Return	`boolean`		`true` if bin notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinHierarchy
Description	Tests if a bin hierarchy traversal is supported.
Return	`boolean`		`true` if a bin hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinHierarchyDesign
Description	Tests if a bin hierarchy design is supported.
Return	`boolean`		`true` if a bin hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceBatch
Description	Tests if a resource batch service is available.
Return	`boolean`		`true` if a resource batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceDemographic
Description	Tests if a resource demographic service is available.
Return	`boolean`		`true` if a resource demographic service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRecordTypes
Description	Gets all the resource record types supported.
Return	`osid.type.TypeList`		the list of supported resource record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRecordType
Description	Tests if a given resource record type is supported.
Parameters	`osid.type.Type`	`resourceRecordType`	the resource type
Return	`boolean`		`true` if the resource record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`resourceRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResourceSearchRecordTypes
Description	Gets all the resource search record types supported.
Return	`osid.type.TypeList`		the list of supported resource search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceSearchRecordType
Description	Tests if a given resource search type is supported.
Parameters	`osid.type.Type`	`resourceSearchRecordType`	the resource search type
Return	`boolean`		`true` if the resource search record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`resourceSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipRecordTypes
Description	Gets the supported `ResourceRelationship` record types.
Return	`osid.type.TypeList`		a list containing the supported `ResourceRelationship` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipRecordType
Description	Tests if the given `ResourceRelationship` record type is supported.
Parameters	`osid.type.Type`	`resourceRelationshipRecordType`	a `Type` indicating a `ResourceRelationship` record type
Return	`boolean`		`true` if the given type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`resourceRelationshipRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipSearchRecordTypes
Description	Gets the supported `ResourceRelationship` search record types.
Return	`osid.type.TypeList`		a list containing the supported `ResourceRelationship` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipSearchRecordType
Description	Tests if the given `ResourceRelationship` search record type is supported.
Parameters	`osid.type.Type`	`resourceRelationshipSearchRecordType`	a `Type` indicating a `ResourceRelationship` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`resourceRelationshipSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBinRecordTypes
Description	Gets all the bin record types supported.
Return	`osid.type.TypeList`		the list of supported bin record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinRecordType
Description	Tests if a given bin record type is supported.
Parameters	`osid.type.Type`	`binRecordType`	the bin record type
Return	`boolean`		`true` if the bin record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`binRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBinSearchRecordTypes
Description	Gets all the bin search record types supported.
Return	`osid.type.TypeList`		the list of supported bin search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinSearchRecordType
Description	Tests if a given bin search record type is supported.
Parameters	`osid.type.Type`	`binSearchRecordType`	the bin search record type
Return	`boolean`		`true` if the bin search record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`binSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.