com.ibm.mashups.enabler.services
Interface IdentificationService


public IdentificationService

Interface to work with client side ids.

Since:
3.0

Method Summary
 String createClientID()
           Returns a new client side ID.
 void attachClientID(Object clientID)
           This method attaches a client side id to make it know to the service
 void releaseClientID(String id)
           Releases an earlier through getClientID loaded client id.
 boolean isClientID(String id)
           Checks whether the specified id is a client id of this IdentificationService
 boolean isServerID(String id)
           Checks whether the specified id is a server id generated by the underling server implementation
 boolean isAlienID(String id)
           Checks whether the specified id is neither an client id nor an server id but is specified outside the mashup framework.
 void attachServerID(Object clientID, Object serverID)
           This method attaches a server side id to an existing client side id.
 String resolveID(String id)
           Returns the attached server side id for any given client side id.
 com.ibm.mashups.enabler.Identifiable resolveIdentifiable(String id)
           Returns the attached server side id for any given client side id.
 

Method Detail

createClientID

String createClientID()
Returns a new client side ID.

Returns:
client side id; never null.

attachClientID

void attachClientID(Object clientID)
This method attaches a client side id to make it know to the service

Parameters:
clientID - client side id as string or Identifiable object
Since:
3.0.0.1

releaseClientID

void releaseClientID(String id)
Releases an earlier through getClientID loaded client id.

Parameters:
id - the id to release

isClientID

boolean isClientID(String id)
Checks whether the specified id is a client id of this IdentificationService

Parameters:
id - the id to check for client id
Returns:
true if the specified id is a client id false otherwise.

isServerID

boolean isServerID(String id)
Checks whether the specified id is a server id generated by the underling server implementation

Parameters:
id - the id to check for server id
Returns:
true if the specified id is a server id false otherwise.

isAlienID

boolean isAlienID(String id)
Checks whether the specified id is neither an client id nor an server id but is specified outside the mashup framework.

Parameters:
id - the id to check for alien id
Returns:
true if the specified id is a alien id false otherwise.

attachServerID

void attachServerID(Object clientID,
                    Object serverID)
This method attaches a server side id to an existing client side id.

Parameters:
clientID - client side id as string or Identifiable object
serverID - server side id as string or Identifiable object

resolveID

String resolveID(String id)
Returns the attached server side id for any given client side id. Returns the specified id, if it cannot be resolved.

Parameters:
id - the id to resolve
Returns:
id the resolved id

resolveIdentifiable

com.ibm.mashups.enabler.Identifiable resolveIdentifiable(String id)
Returns the attached server side id for any given client side id. Returns the specified id, if it cannot be resolved.

Parameters:
id - the id to resolve
Returns:
id the resolved id


Copyright IBM Corp. 2010 All Rights Reserved.