Objects

Id Form

class dlkit.id.objects.IdForm

Bases: dlkit.osid.objects.OsidForm

This form provides a means of creating an Id.

authority_metadata

Gets the metadata for the authority.

Returns:metadata for the authority Return type:osid.Metadata

compliance: mandatory – This method must be implemented.

authority

identifier_namespace_metadata

Gets the metadata for the identifier namespace.

Returns:metadata for the namespace Return type:osid.Metadata

compliance: mandatory – This method must be implemented.

identifier_namespace

identifier_prefix_metadata

Gets the metadata for the identifier prefix.

Returns:metadata for the prefix Return type:osid.Metadata

compliance: mandatory – This method must be implemented.

identifier_prefix

identifier_suffix_metadata

Gets the metadata for the identifier suffix.

Returns:metadata for the suffix Return type:osid.Metadata

compliance: mandatory – This method must be implemented.

identifier_suffix

identifier_metadata

Gets the metadata for the identifier.

Returns:metadata for the identifier Return type:osid.Metadata

compliance: mandatory – This method must be implemented.

identifier

Id List

class dlkit.id.objects.IdList

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, IdList provides a means for accessing Id elements sequentially either one at a time or many at a time.

Examples: while (il.hasNext()) { Id id = il.getNextId(); }

or

while (il.hasNext()) {

Id[] ids = il.getNextIds(il.available());

}

next_id

Gets the next Id in this list.

Returns:the next Id in this list. The has_next() method should be used to test that a next Id is available before calling this method. Return type:osid.id.Id Raise:IllegalState – no more elements available in this list Raise:OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.

get_next_ids(n)

Gets the next set of Ids in this list.

The specified amount must be less than or equal to the return from available().

Parameters:n (cardinal) – the number of Id elements requested which must be less than or equal to available() Returns:an array of Id elements.The length of the array is less than or equal to the number specified. Return type:osid.id.Id Raise:IllegalState – no more elements available in this list Raise:OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.