org.osid.resource

Interface ResourceProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

ResourceManager, ResourceProxyManager

public interface ResourceProfile
extends OsidProfile

The resource profile describes interoperability among resource services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getBinRecordTypes() Gets all the bin record types supported.
TypeList	getBinSearchRecordTypes() Gets all the bin search record types supported.
TypeList	getResourceRecordTypes() Gets all the resource record types supported.
TypeList	getResourceRelationshipRecordTypes() Gets the supported ResourceRelationship record types.
TypeList	getResourceRelationshipSearchRecordTypes() Gets the supported ResourceRelationship search record types.
TypeList	getResourceSearchRecordTypes() Gets all the resource search record types supported.
boolean	supportsBinAdmin() Tests if bin administration is supported.
boolean	supportsBinHierarchy() Tests if a bin hierarchy traversal is supported.
boolean	supportsBinHierarchyDesign() Tests if a bin hierarchy design is supported.
boolean	supportsBinLookup() Tests if bin lookup is supported.
boolean	supportsBinNotification() Tests if bin notification is supported.
boolean	supportsBinQuery() Tests if bin query is supported.
boolean	supportsBinRecordType(Type binRecordType) Tests if a given bin record type is supported.
boolean	supportsBinSearch() Tests if bin search is supported.
boolean	supportsBinSearchRecordType(Type binSearchRecordType) Tests if a given bin search record type is supported.
boolean	supportsGroup() Tests if group resources are supported.
boolean	supportsGroupAssignment() Tests if group resource assignment is supported.
boolean	supportsGroupHierarchy() Tests if a group resource hierarchy service is supported.
boolean	supportsGroupNotification() Tests if group resource notification is supported.
boolean	supportsMembership() Tests if membership queries are supported.
boolean	supportsResourceAdmin() Tests if resource administration is supported.
boolean	supportsResourceAgent() Tests if retrieving mappings of resource and agents is supported.
boolean	supportsResourceAgentAssignment() Tests if managing mappings of resources and agents is supported.
boolean	supportsResourceBatch() Tests if a resource batch service is available.
boolean	supportsResourceBin() Tests if retrieving mappings of resource and bins is supported.
boolean	supportsResourceBinAssignment() Tests if managing mappings of resource and bins is supported.
boolean	supportsResourceDemographic() Tests if a resource demographic service is available.
boolean	supportsResourceLookup() Tests if resource lookup is supported.
boolean	supportsResourceNotification() Tests if resource notification is supported.
boolean	supportsResourceQuery() Tests if resource query is supported.
boolean	supportsResourceRecordType(Type resourceRecordType) Tests if a given resource record type is supported.
boolean	supportsResourceRelationshipAdmin() Tests if a resource relationships administrative service is supported.
boolean	supportsResourceRelationshipBin() Tests if retrieving mappings of resource relationships and bins is supported.
boolean	supportsResourceRelationshipBinAssignment() Tests if managing mappings of resource relationships and bins is supported.
boolean	supportsResourceRelationshipLookup() Tests if looking up resource relationships is supported.
boolean	supportsResourceRelationshipNotification() Tests if a resource relationships notification service is supported.
boolean	supportsResourceRelationshipQuery() Tests if querying resource relationships is supported.
boolean	supportsResourceRelationshipRecordType(Type resourceRelationshipRecordType) Tests if the given ResourceRelationship record type is supported.
boolean	supportsResourceRelationshipSearch() Tests if searching resource relationships is supported.
boolean	supportsResourceRelationshipSearchRecordType(Type resourceRelationshipSearchRecordType) Tests if the given ResourceRelationship search record type is supported.
boolean	supportsResourceRelationshipSmartBin() Tests if resource relationship smart bins are available.
boolean	supportsResourceSearch() Tests if resource search is supported.
boolean	supportsResourceSearchRecordType(Type resourceSearchRecordType) Tests if a given resource search type is supported.
boolean	supportsResourceSmartBin() Tests if resource smart bins are available.
boolean	supportsVisibleFederation() Tests if federation is visible.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if federation is visible.

Returns:

true if visible federation is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceLookup

boolean supportsResourceLookup()

Tests if resource lookup is supported.

Returns:

true if resource lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if resource query is supported.

Returns:

true if resource query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceSearch

boolean supportsResourceSearch()

Tests if resource search is supported.

Returns:

true if resource search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceAdmin

boolean supportsResourceAdmin()

Tests if resource administration is supported.

Returns:

true if resource administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceNotification

boolean supportsResourceNotification()

Tests if resource notification is supported. Messages may be sent when resources are created, modified, or deleted.

Returns:

true if resource notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceBin

boolean supportsResourceBin()

Tests if retrieving mappings of resource and bins is supported.

Returns:

true if resource bin mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceBinAssignment

boolean supportsResourceBinAssignment()

Tests if managing mappings of resource and bins is supported.

Returns:

true if resource bin assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceSmartBin

boolean supportsResourceSmartBin()

Tests if resource smart bins are available.

Returns:

true if resource smart bins are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMembership

boolean supportsMembership()

Tests if membership queries are supported.

Returns:

true if membership queries are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGroup

boolean supportsGroup()

Tests if group resources are supported.

Returns:

true if group resources are supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGroupAssignment

boolean supportsGroupAssignment()

Tests if group resource assignment is supported.

Returns:

true if group resource assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGroupNotification

boolean supportsGroupNotification()

Tests if group resource notification is supported.

Returns:

true if group resource notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGroupHierarchy

boolean supportsGroupHierarchy()

Tests if a group resource hierarchy service is supported.

Returns:

true if group resource hierarchy is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceAgent

boolean supportsResourceAgent()

Tests if retrieving mappings of resource and agents is supported.

Returns:

true if resource agent mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceAgentAssignment

boolean supportsResourceAgentAssignment()

Tests if managing mappings of resources and agents is supported.

Returns:

true if resource agent assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipLookup

boolean supportsResourceRelationshipLookup()

Tests if looking up resource relationships is supported.

Returns:

true if resource relationships lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipQuery

boolean supportsResourceRelationshipQuery()

Tests if querying resource relationships is supported.

Returns:

true if resource relationships query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipSearch

boolean supportsResourceRelationshipSearch()

Tests if searching resource relationships is supported.

Returns:

true if resource relationships search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipAdmin

boolean supportsResourceRelationshipAdmin()

Tests if a resource relationships administrative service is supported.

Returns:

true if resource relationships administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipNotification

boolean supportsResourceRelationshipNotification()

Tests if a resource relationships notification service is supported.

Returns:

true if resource relationships notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipBin

boolean supportsResourceRelationshipBin()

Tests if retrieving mappings of resource relationships and bins is supported.

Returns:

true if resource relationship bin mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipBinAssignment

boolean supportsResourceRelationshipBinAssignment()

Tests if managing mappings of resource relationships and bins is supported.

Returns:

true if resource relationship bin assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipSmartBin

boolean supportsResourceRelationshipSmartBin()

Tests if resource relationship smart bins are available.

Returns:

true if resource relationship smart bins are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBinLookup

boolean supportsBinLookup()

Tests if bin lookup is supported.

Returns:

true if bin lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBinQuery

boolean supportsBinQuery()

Tests if bin query is supported.

Returns:

true if bin query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBinSearch

boolean supportsBinSearch()

Tests if bin search is supported.

Returns:

true if bin search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBinAdmin

boolean supportsBinAdmin()

Tests if bin administration is supported.

Returns:

true if bin administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBinNotification

boolean supportsBinNotification()

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.

Returns:

true if bin notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBinHierarchy

boolean supportsBinHierarchy()

Tests if a bin hierarchy traversal is supported.

Returns:

true if a bin hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBinHierarchyDesign

boolean supportsBinHierarchyDesign()

Tests if a bin hierarchy design is supported.

Returns:

true if a bin hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceBatch

boolean supportsResourceBatch()

Tests if a resource batch service is available.

Returns:

true if a resource batch service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceDemographic

boolean supportsResourceDemographic()

Tests if a resource demographic service is available.

Returns:

true if a resource demographic service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceRecordTypes

TypeList getResourceRecordTypes()

Gets all the resource record types supported.

Returns:

the list of supported resource record types

Compliance:

mandatory - This method must be implemented.

supportsResourceRecordType

boolean supportsResourceRecordType(Type resourceRecordType)

Tests if a given resource record type is supported.

Parameters:

resourceRecordType - the resource type

Returns:

true if the resource record type is supported , false otherwise

Throws:

NullArgumentException - resourceRecordType is null

Compliance:

mandatory - This method must be implemented.

getResourceSearchRecordTypes

TypeList getResourceSearchRecordTypes()

Gets all the resource search record types supported.

Returns:

the list of supported resource search record types

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchRecordType

boolean supportsResourceSearchRecordType(Type resourceSearchRecordType)

Tests if a given resource search type is supported.

Parameters:

resourceSearchRecordType - the resource search type

Returns:

true if the resource search record type is supported , false otherwise

Throws:

NullArgumentException - resourceSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipRecordTypes

TypeList getResourceRelationshipRecordTypes()

Gets the supported ResourceRelationship record types.

Returns:

a list containing the supported ResourceRelationship record types

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipRecordType

boolean supportsResourceRelationshipRecordType(Type resourceRelationshipRecordType)

Tests if the given ResourceRelationship record type is supported.

Parameters:

resourceRelationshipRecordType - a Type indicating a ResourceRelationship record type

Returns:

true if the given type is supported, false otherwise

Throws:

NullArgumentException - resourceRelationshipRecordType is null

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipSearchRecordTypes

TypeList getResourceRelationshipSearchRecordTypes()

Gets the supported ResourceRelationship search record types.

Returns:

a list containing the supported ResourceRelationship search record types

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipSearchRecordType

boolean supportsResourceRelationshipSearchRecordType(Type resourceRelationshipSearchRecordType)

Tests if the given ResourceRelationship search record type is supported.

Parameters:

resourceRelationshipSearchRecordType - a Type indicating a ResourceRelationship search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - resourceRelationshipSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getBinRecordTypes

TypeList getBinRecordTypes()

Gets all the bin record types supported.

Returns:

the list of supported bin record types

Compliance:

mandatory - This method must be implemented.

supportsBinRecordType

boolean supportsBinRecordType(Type binRecordType)

Tests if a given bin record type is supported.

Parameters:

binRecordType - the bin record type

Returns:

true if the bin record type is supported , false otherwise

Throws:

NullArgumentException - binRecordType is null

Compliance:

mandatory - This method must be implemented.

getBinSearchRecordTypes

TypeList getBinSearchRecordTypes()

Gets all the bin search record types supported.

Returns:

the list of supported bin search record types

Compliance:

mandatory - This method must be implemented.

supportsBinSearchRecordType

boolean supportsBinSearchRecordType(Type binSearchRecordType)

Tests if a given bin search record type is supported.

Parameters:

binSearchRecordType - the bin search record type

Returns:

true if the bin search record type is supported , false otherwise

Throws:

NullArgumentException - binSearchRecordType is null

Compliance:

mandatory - This method must be implemented.