Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class UserLicense

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.object.UserLicense

public class UserLicense
extends BusinessObject

A user license grants access to applications within the Primavera suite.

UserLicense business objects may not be updated. To change the values on a UserLicense object, create a new object with the desired values and delete the old object.

See Also:   Quick reference of UserLicense fields


Constructor Summary
UserLicense(Session session)
          Class constructor specifying the Session.
UserLicense(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
UserLicense(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId create()
          Creates this UserLicense object in the database.
static ObjectId[] create(Session session, UserLicense[] userlicenses)
          Creates multiple UserLicense objects in the database.
 void delete()
          Deletes this UserLicense object from the database.
static void delete(Session session, UserLicense[] userlicenses)
          Deletes multiple UserLicense objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.util.Date getCreateDate()
          Gets the date this user license was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this user license.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 java.util.Date getLastUpdateDate()
          Gets the date this user license was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this user license.
 LicenseType getLicenseType()
          Gets the type of product for which the user has a license.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 java.lang.String getUserName()
          Gets the user's login name.
 ObjectId getUserObjectId()
          Gets the unique ID of the associated user.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static UserLicense load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single UserLicense object from the database.
static BOIterator<UserLicense> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple UserLicense objects from the database.
 User loadUser(java.lang.String[] fields)
          Loads an associated User object from the database.
 void setLicenseType(LicenseType enm)
          Sets the type of product for which the user has a license.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setUserObjectId(ObjectId o)
          Sets the unique ID of the associated user.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UserLicense

public UserLicense(Session session)
Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.

Parameters:
session - the Session

UserLicense

public UserLicense(Session session,
                   ObjectId objId)
            throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

UserLicense

public UserLicense(Session session,
                   com.primavera.infr.db.PrmRowSet rowSet,
                   int iIndex)
            throws BusinessObjectException
Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.

Parameters:
session - the Session
rowSet - the PrmRowSet retrieved from the server
iIndex - the row index in the PrmRowSet associated with this business object
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
Method Detail

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this UserLicense object in the database.

Returns:
ObjectId the unique ID of the newly created UserLicense object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

create

public static ObjectId[] create(Session session,
                                UserLicense[] userlicenses)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple UserLicense objects in the database.

Parameters:
session - the Session object
userlicenses - array of UserLicense objects to create
Returns:
ObjectId[] the array of unique IDs of newly created UserLicense objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

load

public static UserLicense load(Session session,
                               java.lang.String[] fields,
                               ObjectId objId)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Loads a single UserLicense object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the UserLicense object
Returns:
UserLicense the UserLicense object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

load

public static BOIterator<UserLicense> load(Session session,
                                           java.lang.String[] fields,
                                           ObjectId[] objIds)
                                    throws ServerException,
                                           NetworkException,
                                           BusinessObjectException
Loads multiple UserLicense objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the UserLicense objects
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

delete

public void delete()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this UserLicense object from the database.

Overrides:
delete in class BOBase
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

delete

public static void delete(Session session,
                          UserLicense[] userlicenses)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple UserLicense objects from the database.

Parameters:
session - the Session object
userlicenses - array of UserLicense objects to delete
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadUser

public User loadUser(java.lang.String[] fields)
              throws ServerException,
                     NetworkException,
                     BusinessObjectException
Loads an associated User object from the database.

Parameters:
fields - fields to load
Returns:
User the User object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setObjectId

public void setObjectId(ObjectId o)
                 throws BusinessObjectException
Sets the unique ID generated by the system.

Overrides:
setObjectId in class BusinessObject
Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUserObjectId

public ObjectId getUserObjectId()
                         throws BusinessObjectException
Gets the unique ID of the associated user. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field UserObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUserObjectId

public void setUserObjectId(ObjectId o)
                     throws BusinessObjectException
Sets the unique ID of the associated user. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUserName

public java.lang.String getUserName()
                             throws BusinessObjectException
Gets the user's login name.

Returns:
the value in the field UserName
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLicenseType

public LicenseType getLicenseType()
                           throws BusinessObjectException
Gets the type of product for which the user has a license. Valid values are 'Project Management', 'Portfolio Analysis', 'Timesheets', 'Primavera Portfolios', 'Primavera Projects', and 'Primavera Resources'. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field LicenseType
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setLicenseType

public void setLicenseType(LicenseType enm)
                    throws BusinessObjectException
Sets the type of product for which the user has a license. Valid values are 'Project Management', 'Portfolio Analysis', 'Timesheets', 'Primavera Portfolios', 'Primavera Projects', and 'Primavera Resources'. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
enm - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this user license was created.

Returns:
the value in the field CreateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this user license was last updated.

Returns:
the value in the field LastUpdateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this user license.

Returns:
the value in the field CreateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this user license.

Returns:
the value in the field LastUpdateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

public static java.lang.String[] getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.

Returns:
String[] an array of required create fields

getFilterableFields

public static java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.String[] getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:
String[] an array of exported fields

toString

public java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.