org.osid.profile

Interface ProfileProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

ProfileManager, ProfileProxyManager

public interface ProfileProfile
extends OsidProfile

The ProfileProfile describes the interoperability among authentication services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getProfileEntryConditionRecordTypes() Gets the supported ProfileEntryCondition record types.
TypeList	getProfileEntryRecordTypes() Gets the supported ProfileEntry record types.
TypeList	getProfileEntrySearchRecordTypes() Gets the supported ProfileEntry search record types.
TypeList	getProfileItemRecordTypes() Gets the supported ProfileItem record types.
TypeList	getProfileItemSearchRecordTypes() Gets the supported ProfileItem search record types.
TypeList	getProfileRecordTypes() Gets the supported Profile record types.
TypeList	getProfileSearchRecordTypes() Gets the supported profile search record types.
boolean	supportsProfileAdmin() Tests if a profile administrative service is supported.
boolean	supportsProfileBatch() Tests if a profile batch service is supported.
boolean	supportsProfileEntryAdmin() Tests if a profile entry administrative service is supported.
boolean	supportsProfileEntryConditionRecordType(Type profileEntryConditionRecordType) Tests if the given ProfileEntryCondition record type is supported.
boolean	supportsProfileEntryLookup() Tests if a profile entry lookup service is supported.
boolean	supportsProfileEntryNotification() Tests if profile entry notification is supported.
boolean	supportsProfileEntryProfile() Tests if retrieving mappings of profile entries and profile is supported.
boolean	supportsProfileEntryProfileAssignment() Tests if managing mappings of profile entries and profile is supported.
boolean	supportsProfileEntryQuery() Tests if profile entry query is supported.
boolean	supportsProfileEntryRecordType(Type profileEntryRecordType) Tests if the given profile entry record type is supported.
boolean	supportsProfileEntryRelationshpSmartProfile() Tests if profile entry smart profiles are available.
boolean	supportsProfileEntrySearch() Tests if a profile entry search service is supported.
boolean	supportsProfileEntrySearchRecordType(Type profileEntrySearchRecordType) Tests if the given profile entry search record type is supported.
boolean	supportsProfileHierarchy() Tests if a profile hierarchy traversal is supported.
boolean	supportsProfileHierarchyDesign() Tests if profile hierarchy design is supported.
boolean	supportsProfileItemAdmin() Tests if a profile item administrative service is supported.
boolean	supportsProfileItemLookup() Tests if a profile item lookup service is supported.
boolean	supportsProfileItemNotification() Tests if profile item notification is supported.
boolean	supportsProfileItemProfile() Tests if a profile item to profile lookup session is available.
boolean	supportsProfileItemProfileAssignment() Tests if a profile item to profile assignment session is available.
boolean	supportsProfileItemQuery() Tests if profile item query is supported.
boolean	supportsProfileItemRecordType(Type profileItemRecordType) Tests if the given ProfileItem record type is supported.
boolean	supportsProfileItemSearch() Tests if a profile item search service is supported.
boolean	supportsProfileItemSearchRecordType(Type profileItemSearchRecordType) Tests if the given ProfileItem search record type is supported.
boolean	supportsProfileItemSmartProfile() Tests if profile item smart profiles are available.
boolean	supportsProfileLookup() Tests if a profile lookup service is supported.
boolean	supportsProfileNotification() Tests if profile notification is supported.
boolean	supportsProfileQuery() Tests if profile query is supported.
boolean	supportsProfileRecordType(Type profileRecordType) Tests if the given Profile record type is supported.
boolean	supportsProfileRules() Tests if a profile rules service is supported.
boolean	supportsProfileSearch() Tests if a profile search service is supported.
boolean	supportsProfileSearchRecordType(Type profileSearchRecordType) Tests if the given profile search record type is supported.
boolean	supportsProfiling() Tests for the availability of a profile service which is the basic service for checking profiles.
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.

supportsProfiling

boolean supportsProfiling()

Tests for the availability of a profile service which is the basic service for checking profiles.

Returns:

true if profiling is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileEntryLookup

boolean supportsProfileEntryLookup()

Tests if a profile entry lookup service is supported. A profile entry lookup service defines methods to access profile entries.

Returns:

true if profile entry lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileEntryQuery

boolean supportsProfileEntryQuery()

Tests if profile entry query is supported.

Returns:

true if profile entry query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileEntrySearch

boolean supportsProfileEntrySearch()

Tests if a profile entry search service is supported.

Returns:

true if profile entry search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileEntryAdmin

boolean supportsProfileEntryAdmin()

Tests if a profile entry administrative service is supported.

Returns:

true if profile entry admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileEntryNotification

boolean supportsProfileEntryNotification()

Tests if profile entry notification is supported. Messages may be sent when peofile entries are created, modified, or deleted.

Returns:

true if profile entry notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileEntryProfile

boolean supportsProfileEntryProfile()

Tests if retrieving mappings of profile entries and profile is supported.

Returns:

true if profile entry profile mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileEntryProfileAssignment

boolean supportsProfileEntryProfileAssignment()

Tests if managing mappings of profile entries and profile is supported.

Returns:

true if profile entry profile assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileEntryRelationshpSmartProfile

boolean supportsProfileEntryRelationshpSmartProfile()

Tests if profile entry smart profiles are available.

Returns:

true if profile entry smart profiles are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileItemLookup

boolean supportsProfileItemLookup()

Tests if a profile item lookup service is supported. A profile item lookup service defines methods to access profile items.

Returns:

true if profile item lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileItemQuery

boolean supportsProfileItemQuery()

Tests if profile item query is supported.

Returns:

true if profile item query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileItemSearch

boolean supportsProfileItemSearch()

Tests if a profile item search service is supported.

Returns:

true if profile item search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileItemAdmin

boolean supportsProfileItemAdmin()

Tests if a profile item administrative service is supported.

Returns:

true if profile item admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileItemNotification

boolean supportsProfileItemNotification()

Tests if profile item notification is supported. Messages may be sent when profile items are created, modified, or deleted.

Returns:

true if profile item notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileItemProfile

boolean supportsProfileItemProfile()

Tests if a profile item to profile lookup session is available.

Returns:

true if profile item profile lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileItemProfileAssignment

boolean supportsProfileItemProfileAssignment()

Tests if a profile item to profile assignment session is available.

Returns:

true if profile item profile assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileItemSmartProfile

boolean supportsProfileItemSmartProfile()

Tests if profile item smart profiles are available.

Returns:

true if profile item smart profiles are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileLookup

boolean supportsProfileLookup()

Tests if a profile lookup service is supported. A profile lookup service defines methods to access profiles.

Returns:

true if profile lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileQuery

boolean supportsProfileQuery()

Tests if profile query is supported.

Returns:

true if profile query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileSearch

boolean supportsProfileSearch()

Tests if a profile search service is supported.

Returns:

true if profile search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileAdmin

boolean supportsProfileAdmin()

Tests if a profile administrative service is supported.

Returns:

true if profile admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileNotification

boolean supportsProfileNotification()

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

Returns:

true if profile notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileHierarchy

boolean supportsProfileHierarchy()

Tests if a profile hierarchy traversal is supported.

Returns:

true if a profile hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileHierarchyDesign

boolean supportsProfileHierarchyDesign()

Tests if profile hierarchy design is supported.

Returns:

true if a profile hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileBatch

boolean supportsProfileBatch()

Tests if a profile batch service is supported.

Returns:

true if a profile batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProfileRules

boolean supportsProfileRules()

Tests if a profile rules service is supported.

Returns:

true if a profile rules service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getProfileEntryRecordTypes

TypeList getProfileEntryRecordTypes()

Gets the supported ProfileEntry record types.

Returns:

a list containing the supported profile entry record types

Compliance:

mandatory - This method must be implemented.

supportsProfileEntryRecordType

boolean supportsProfileEntryRecordType(Type profileEntryRecordType)

Tests if the given profile entry record type is supported.

Parameters:

profileEntryRecordType - a Type indicating a profile entry record type

Returns:

true if the given record Type is supported, false otherwise

Throws:

NullArgumentException - profileEntryRecordType is null

Compliance:

mandatory - This method must be implemented.

getProfileEntrySearchRecordTypes

TypeList getProfileEntrySearchRecordTypes()

Gets the supported ProfileEntry search record types.

Returns:

a list containing the supported profile entry search record types

Compliance:

mandatory - This method must be implemented.

supportsProfileEntrySearchRecordType

boolean supportsProfileEntrySearchRecordType(Type profileEntrySearchRecordType)

Tests if the given profile entry search record type is supported.

Parameters:

profileEntrySearchRecordType - a Type indicating a profile entry search record type

Returns:

true if the given search record Type is supported, false otherwise

Throws:

NullArgumentException - profileEntrySearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getProfileItemRecordTypes

TypeList getProfileItemRecordTypes()

Gets the supported ProfileItem record types.

Returns:

a list containing the supported ProfileItem record types

Compliance:

mandatory - This method must be implemented.

supportsProfileItemRecordType

boolean supportsProfileItemRecordType(Type profileItemRecordType)

Tests if the given ProfileItem record type is supported.

Parameters:

profileItemRecordType - a Type indicating a ProfileItem record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - profileItemRecordType is null

Compliance:

mandatory - This method must be implemented.

getProfileItemSearchRecordTypes

TypeList getProfileItemSearchRecordTypes()

Gets the supported ProfileItem search record types.

Returns:

a list containing the supported ProfileItem search record types

Compliance:

mandatory - This method must be implemented.

supportsProfileItemSearchRecordType

boolean supportsProfileItemSearchRecordType(Type profileItemSearchRecordType)

Tests if the given ProfileItem search record type is supported.

Parameters:

profileItemSearchRecordType - a Type indicating a ProfileItem search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - profileItemSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getProfileRecordTypes

TypeList getProfileRecordTypes()

Gets the supported Profile record types.

Returns:

a list containing the supported Profile record types

Compliance:

mandatory - This method must be implemented.

supportsProfileRecordType

boolean supportsProfileRecordType(Type profileRecordType)

Tests if the given Profile record type is supported.

Parameters:

profileRecordType - a Type indicating a Profile type

Returns:

true if the given profile record Type is supported, false otherwise

Throws:

NullArgumentException - profileRecordType is null

Compliance:

mandatory - This method must be implemented.

getProfileSearchRecordTypes

TypeList getProfileSearchRecordTypes()

Gets the supported profile search record types.

Returns:

a list containing the supported Profile search record types

Compliance:

mandatory - This method must be implemented.

supportsProfileSearchRecordType

boolean supportsProfileSearchRecordType(Type profileSearchRecordType)

Tests if the given profile search record type is supported.

Parameters:

profileSearchRecordType - a Type indicating a Profile search record type

Returns:

true if the given search record Type is supported, false otherwise

Throws:

NullArgumentException - profileSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getProfileEntryConditionRecordTypes

TypeList getProfileEntryConditionRecordTypes()

Gets the supported ProfileEntryCondition record types.

Returns:

a list containing the supported ProfileEntryCondition record types

Compliance:

mandatory - This method must be implemented.

supportsProfileEntryConditionRecordType

boolean supportsProfileEntryConditionRecordType(Type profileEntryConditionRecordType)

Tests if the given ProfileEntryCondition record type is supported.

Parameters:

profileEntryConditionRecordType - a Type indicating an ProfileEntryCondition record type

Returns:

true if the given profile entry condition record Type is supported, false otherwise

Throws:

NullArgumentException - profileEntryConditionRecordType is null

Compliance:

mandatory - This method must be implemented.