|
Primavera Integration API 6.2.1 SP1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.UserLicense
public class UserLicense
A user license grants access to applications within the Primavera suite. A named user is always guaranteed access to the application. When you assign licenses to users, you are not allowed to exceed the number of named licenses. The maximum number of named users varies from site to site, based on purchasing decisions.
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.bo.common.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 |
boolean |
getNamedUserFlag()
Gets the value of the flag that indicates if the user is a named user. |
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 |
setNamedUserFlag(boolean b)
Sets the value of the flag that indicates if the user is a named user. |
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 |
---|
public UserLicense(Session session)
session
- the Sessionpublic UserLicense(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UserLicense(Session session, com.primavera.bo.common.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
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 objectspublic static ObjectId[] create(Session session, UserLicense[] userlicenses) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectuserlicenses
- array of UserLicense objects to create
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 objectspublic static UserLicense load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the UserLicense object
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 objectspublic static BOIterator<UserLicense> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the UserLicense objects
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 objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
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 objectspublic static void delete(Session session, UserLicense[] userlicenses) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectuserlicenses
- array of UserLicense objects to delete
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 objectspublic User loadUser(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getUserObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUserObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getUserName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getNamedUserFlag() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setNamedUserFlag(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic LicenseType getLicenseType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setLicenseType(LicenseType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static java.lang.String[] getRequiredCreateFields()
public static java.lang.String[] getFilterableFields()
public static java.lang.String[] getInternalDefaultLoadFields()
public static java.lang.String[] getAllFields()
public static java.lang.String[] getInternalAllFields()
public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
public static java.lang.String[] getWritableFields()
public static java.lang.String[] getDefaultXMLExportFields()
public static java.lang.String[] getMinimumXMLExportFields()
public java.lang.String toString()
toString
in class java.lang.Object
|
Primavera Integration API 6.2.1 SP1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |