nesstar.api.acu
Class UserHome

java.lang.Object
  extended by java.util.Observable
      extended by nesstar.rdf.RDFObject
          extended by nesstar.api.acu.UserHome
All Implemented Interfaces:
Comparable, RDFObj

public class UserHome
extends RDFObject

An API class for the UserHome Code automatically generated from ARGO/UML


Field Summary
static String CLASS_ID
           
 
Fields inherited from class nesstar.rdf.RDFObject
COLSEP, IS_GETTER, IS_PART, IS_PART_OF, WRITE_OP
 
Constructor Summary
UserHome(RDFDB db, URL id)
          Create an object with the indicated id in the indicated db
 
Method Summary
 Bookmark create(String comment, String id, String password, String roleid, String purposeid, String label)
          
 User create(String comment, String id, String password, String roleid, String purposeid, String label, BasicExecutorLog log)
          
 Bookmark delete(String id)
           
 void delete(String id, BasicExecutorLog log)
           
 Bookmark EJBQuery(String query)
           
 List EJBQuery(String where, BasicExecutorLog log)
           
 Bookmark findAll()
           
 List findAll(BasicExecutorLog log)
           
 Bookmark findByKey(String id)
           
 User findByKey(String id, BasicExecutorLog log)
           
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
 Bookmark getCurrentUser()
           retrieves the user logged in the current session
 User getCurrentUser(BasicExecutorLog log)
           retrieves the user logged in the current session
static UserHome getInstance(RDFDB db, URL id)
          If an object of type UserHome with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static UserHome getInstance(String rdf)
           
 void initialised()
          Notify that the object has been created and its properties setup for the first time.
static void listenForNewObj(NewObjListener listener)
          Register to be notified when new objects are added.
static UserHome retrieve(URL id)
          If an object of type UserHome with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)
 Bookmark update(String comment, String id, String password, String purposeid, String roleid, String label)
           
 User update(String comment, String id, String password, String purposeid, String roleid, String label, BasicExecutorLog log)
           
 
Methods inherited from class nesstar.rdf.RDFObject
AddProperty, AddStringProperty, chkFinal, clear, compareTo, dbg, equals, err, err, get_comment, get_creationDate, get_label, get, getAccessCondition, getBinding, getBindings, getBookmarkLabel, getCollectionURL, getComment, getCreationDate, getDB, getDescriptor, getDescriptor, getDomain, getGetterMethods, getID, getInitialisedProperties, getInternalID, getLabel, getLastClear, getPartsDescriptor, getPartsDescriptor, getPartsDescriptor, getPath, getProperties, GetProperties, GetProperty, GetPropertyStatement, GetPropertyStatements, getRange, getRangeType, getRef, getRef, getServer, getShortId, getShortID, getStatementHome, GetStringProperties, GetStringProperty, getTimeoutInSecs, getType, init, init, isComplete, isLocal, isMeta, isStale, loaded, neededCollectionReload, neededReload, neededReload, neededReload, neededReload, needsReload, reload, remove, set_comment, set_complete, set_creationDate, set_label, set, setComment, setComplete, setCreationDate, setDB, setHardOrSoft, setID, setLabel, setLastClear, SetProperty, setServer, SetStringProperty, setTimeoutInSecs, setTimestamp, setType, setTypeID, stale, toRDF, toRDFWrapped, toString, update
 
Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_ID

public static String CLASS_ID
Constructor Detail

UserHome

public UserHome(RDFDB db,
                URL id)
         throws Exception
Create an object with the indicated id in the indicated db

Parameters:
db - the db where the object is to be created
id - the id of the object to create
Throws:
Exception
Method Detail

getAllInstances

public static Vector getAllInstances(RDFDB db)
                              throws Exception
Parameters:
db - the db where the instances are to be found
Returns:
all the instances of this class in the database
Throws:
Exception

getAllInstances

public static Vector getAllInstances()
                              throws Exception
Returns:
get all the instances of this class from the default database
Throws:
Exception

getInstance

public static UserHome getInstance(RDFDB db,
                                   URL id)
                            throws Exception
If an object of type UserHome with the indicated id exists in the db returns it otherwise create a new object in the db and returns it

Parameters:
db - the db where the object is to be found or created
id - the id of the object to retrieve or create
Returns:
an object of type Server with the indicated id and existing in the indicated db
Throws:
Exception

getInstance

public static UserHome getInstance(String rdf)
                            throws Exception
Parameters:
rdf - some rdf code that contains a description of an object of this kind
Returns:
the single instance of this class described in the passed RDF code
Throws:
Exception

getCurrentUser

public Bookmark getCurrentUser()
                        throws Exception

retrieves the user logged in the current session

Returns:
the current user

Throws:
Exception

getCurrentUser

public User getCurrentUser(BasicExecutorLog log)
                    throws Exception

retrieves the user logged in the current session

Parameters:
log - the Executor of this method;if null a default one is used
Returns:
the current user

Throws:
Exception

listenForNewObj

public static void listenForNewObj(NewObjListener listener)
Register to be notified when new objects are added.

Parameters:
listener - the listener

initialised

public void initialised()
Notify that the object has been created and its properties setup for the first time. This is NOT called when the object is simply reloaded.

Overrides:
initialised in class RDFObject

retrieve

public static UserHome retrieve(URL id)
                         throws Exception
If an object of type UserHome with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)

Parameters:
id - the id of the object to retrieve
Returns:
an object of type UserHome with the indicated id
Throws:
Exception

EJBQuery

public Bookmark EJBQuery(String query)
                  throws Exception
Parameters:
query - An EJB-QL query that returns objects of the type created by this Home.
Throws:
Exception

EJBQuery

public List EJBQuery(String where,
                     BasicExecutorLog log)
              throws Exception
Parameters:
log - the Executor of this method;if null a default one is used
where -
Throws:
Exception

findByKey

public Bookmark findByKey(String id)
                   throws Exception
Parameters:
id - the id of the object to be found
Throws:
Exception

findByKey

public User findByKey(String id,
                      BasicExecutorLog log)
               throws Exception
Parameters:
id - the id of the object to be found
log - the Executor of this method;if null a default one is used
Throws:
Exception

findAll

public Bookmark findAll()
                 throws Exception
Returns:
a list of all the object of this type
Throws:
Exception

findAll

public List findAll(BasicExecutorLog log)
             throws Exception
Parameters:
log - the Executor of this method;if null a default one is used
Returns:
a list of all the object of this type
Throws:
Exception

create

public Bookmark create(String comment,
                       String id,
                       String password,
                       String roleid,
                       String purposeid,
                       String label)
                throws Exception

Parameters:
id - the id of the new user

password - the password of the new user

roleid - a role for the of the new user

comment -
purposeid -
label -
Returns:
a new User

Throws:
Exception

create

public User create(String comment,
                   String id,
                   String password,
                   String roleid,
                   String purposeid,
                   String label,
                   BasicExecutorLog log)
            throws Exception

Parameters:
id - the id of the new user

password - the password of the new user

roleid - a role for the of the new user

comment -
purposeid -
label -
log - the Executor of this method;if null a default one is used
Returns:
a new User

Throws:
Exception

update

public Bookmark update(String comment,
                       String id,
                       String password,
                       String purposeid,
                       String roleid,
                       String label)
                throws Exception
Parameters:
comment -
id -
password -
purposeid -
roleid -
label -
Throws:
Exception

update

public User update(String comment,
                   String id,
                   String password,
                   String purposeid,
                   String roleid,
                   String label,
                   BasicExecutorLog log)
            throws Exception
Parameters:
comment -
id -
password -
purposeid -
roleid -
label -
log - the Executor of this method;if null a default one is used
Throws:
Exception

delete

public Bookmark delete(String id)
                throws Exception
Parameters:
id -
Throws:
Exception

delete

public void delete(String id,
                   BasicExecutorLog log)
            throws Exception
Parameters:
id -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved