OSID - osid.profile.ProfileProfile Service Interface Definition

Interface	osid.profile.ProfileProfile
Implements	`osid.OsidProfile`
Description	The `ProfileProfile` describes the interoperability among authentication 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	supportsProfiling
Description	Tests for the availability of a profile service which is the basic service for checking profiles.
Return	`boolean`		`true` if profiling is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntryLookup
Description	Tests if a profile entry lookup service is supported. A profile entry lookup service defines methods to access profile entries.
Return	`boolean`		true if profile entry lookup is supported, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntryQuery
Description	Tests if profile entry query is supported.
Return	`boolean`		`true` if profile entry query is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntrySearch
Description	Tests if a profile entry search service is supported.
Return	`boolean`		`true` if profile entry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntryAdmin
Description	Tests if a profile entry administrative service is supported.
Return	`boolean`		`true` if profile entry admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntryNotification
Description	Tests if profile entry notification is supported. Messages may be sent when peofile entries are created, modified, or deleted.
Return	`boolean`		`true` if profile entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntryProfile
Description	Tests if retrieving mappings of profile entries and profile is supported.
Return	`boolean`		`true` if profile entry profile mapping retrieval is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntryProfileAssignment
Description	Tests if managing mappings of profile entries and profile is supported.
Return	`boolean`		`true` if profile entry profile assignment is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntryRelationshpSmartProfile
Description	Tests if profile entry smart profiles are available.
Return	`boolean`		`true` if profile entry smart profiles are supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemLookup
Description	Tests if a profile item lookup service is supported. A profile item lookup service defines methods to access profile items.
Return	`boolean`		`true` if profile item lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemQuery
Description	Tests if profile item query is supported.
Return	`boolean`		`true` if profile item query is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemSearch
Description	Tests if a profile item search service is supported.
Return	`boolean`		`true` if profile item search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemAdmin
Description	Tests if a profile item administrative service is supported.
Return	`boolean`		`true` if profile item admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemNotification
Description	Tests if profile item notification is supported. Messages may be sent when profile items are created, modified, or deleted.
Return	`boolean`		`true` if profile item notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemProfile
Description	Tests if a profile item to profile lookup session is available.
Return	`boolean`		`true` if profile item profile lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemProfileAssignment
Description	Tests if a profile item to profile assignment session is available.
Return	`boolean`		`true` if profile item profile assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemSmartProfile
Description	Tests if profile item smart profiles are available.
Return	`boolean`		`true` if profile item smart profiles are supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileLookup
Description	Tests if a profile lookup service is supported. A profile lookup service defines methods to access profiles.
Return	`boolean`		`true` if profile lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileQuery
Description	Tests if profile query is supported.
Return	`boolean`		`true` if profile query is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileSearch
Description	Tests if a profile search service is supported.
Return	`boolean`		`true` if profile search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileAdmin
Description	Tests if a profile administrative service is supported.
Return	`boolean`		`true` if profile admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileNotification
Description	Tests if profile notification is supported. Messages may be sent when profiles are created, modified, or deleted.
Return	`boolean`		`true` if profile notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileHierarchy
Description	Tests if a profile hierarchy traversal is supported.
Return	`boolean`		`true` if a profile hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileHierarchyDesign
Description	Tests if profile hierarchy design is supported.
Return	`boolean`		`true` if a profile hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileBatch
Description	Tests if a profile batch service is supported.
Return	`boolean`		`true` if a profile batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileRules
Description	Tests if a profile rules service is supported.
Return	`boolean`		`true` if a profile rules service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryRecordTypes
Description	Gets the supported `ProfileEntry` record types.
Return	`osid.type.TypeList`		a list containing the supported profile entry record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntryRecordType
Description	Tests if the given profile entry record type is supported.
Parameters	`osid.type.Type`	`profileEntryRecordType`	a `Type` indicating a profile entry record type
Return	`boolean`		`true` if the given record Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileEntryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntrySearchRecordTypes
Description	Gets the supported `ProfileEntry` search record types.
Return	`osid.type.TypeList`		a list containing the supported profile entry search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntrySearchRecordType
Description	Tests if the given profile entry search record type is supported.
Parameters	`osid.type.Type`	`profileEntrySearchRecordType`	a `Type` indicating a profile entry search record type
Return	`boolean`		`true` if the given search record Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileEntrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemRecordTypes
Description	Gets the supported `ProfileItem` record types.
Return	`osid.type.TypeList`		a list containing the supported `ProfileItem` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemRecordType
Description	Tests if the given `ProfileItem` record type is supported.
Parameters	`osid.type.Type`	`profileItemRecordType`	a `Type` indicating a `ProfileItem` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileItemRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemSearchRecordTypes
Description	Gets the supported `ProfileItem` search record types.
Return	`osid.type.TypeList`		a list containing the supported `ProfileItem` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemSearchRecordType
Description	Tests if the given `ProfileItem` search record type is supported.
Parameters	`osid.type.Type`	`profileItemSearchRecordType`	a `Type` indicating a `ProfileItem` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileItemSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileRecordTypes
Description	Gets the supported `Profile` record types.
Return	`osid.type.TypeList`		a list containing the supported `Profile` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileRecordType
Description	Tests if the given `Profile` record type is supported.
Parameters	`osid.type.Type`	`profileRecordType`	a `Type` indicating a `Profile` type
Return	`boolean`		`true` if the given profile record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileSearchRecordTypes
Description	Gets the supported profile search record types.
Return	`osid.type.TypeList`		a list containing the supported `Profile` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileSearchRecordType
Description	Tests if the given profile search record type is supported.
Parameters	`osid.type.Type`	`profileSearchRecordType`	a `Type` indicating a `Profile` search record type
Return	`boolean`		`true` if the given search record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryConditionRecordTypes
Description	Gets the supported `ProfileEntryCondition` record types.
Return	`osid.type.TypeList`		a list containing the supported `ProfileEntryCondition` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileEntryConditionRecordType
Description	Tests if the given `ProfileEntryCondition` record type is supported.
Parameters	`osid.type.Type`	`profileEntryConditionRecordType`	a `Type` indicating an `ProfileEntryCondition` record type
Return	`boolean`		`true` if the given profile entry condition record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileEntryConditionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.