com.ibm.portal
Interface ModifiableObjectID

All Superinterfaces:

Identifiable, Modifiable, ObjectID

public interface ModifiableObjectID
extends ObjectID, Modifiable

An interface representing a modifiable object id instance.

Since:

6.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.portal.ObjectID

ObjectID.Deserializer, ObjectID.Serializer

Method Summary

boolean	confirmSetUniqueName(java.lang.String aUniqueName) Indicate if the unique name of this object id may be set.
java.lang.String	setUniqueName(java.lang.String aUniqueName) Sets the unique name of this object id.

Methods inherited from interface com.ibm.portal.ObjectID

getObjectType, getResourceType, getUniqueName

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Method Detail

setUniqueName

java.lang.String setUniqueName(java.lang.String aUniqueName)
                               throws CannotModifyPropertyException

Sets the unique name of this object id. If the specified unique name is already set for another resource in portal, the unique name will be re-assigned to the current resource. In this case the resource the unique name was associated formerly has no unique name any more.

Parameters:

aUniqueName - the unique name of the resource; if this is null the unique name (if any) will be removed.

Returns:

the former unique name; if none existed, null is returned

Throws:

CannotModifyPropertyException - if the specified unique name cannot be applied.

confirmSetUniqueName

boolean confirmSetUniqueName(java.lang.String aUniqueName)

Indicate if the unique name of this object id may be set.

Parameters:

aUniqueName - unique name for which to indicate if it may be set; if this is null, it is indicated if the unique name may be removed

Returns:

true if either the unique name may be set, or in case null has been specified, the unique name may be removed, false otherwise