com.imc.iss.groovy.user

Class User

java.lang.Object

com.imc.iss.groovy.user.User

public class User
extends Object

This is a class representing a User for use by groovy scripts

Inside the script, an instance of this class, containing the data of the user that the script will be run on, will be provided automatically and can be accessed as a variable named user

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
Object	getUserDataAttributeValue(String attributeURI) To get the value of a user data attribute by attribute URI.
Object	getUserDataAttributeValue1(String attributeURI) To get the value of a user data attribute by attribute URI.
String	getUserRelationAttributeErpId(String attributeURI) To get the ERPID of a user relation attribute by attribute URI.
String	getUserRelationAttributeObjectId(String attributeURI) To get the object Id of a user relation attribute by attribute URI.
String	getUserRelationAttributeObjectName(String attributeURI) To get the object name of a user relation attribute by attribute URI.
String	getuserRelationAttributeURI(String attributeURI) To get the URI of a user relation attribute by attribute URI.
String	getUserURI() Retrieves the URI of this User
User	setUserDataAttribute(String attributeURI, Object value) To set a value for the user data attribute.
User	setUserRelationAttribute(String attributeURI, String valueURI) To set a value for the user relation attribute.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

User

public User()

Method Detail

getUserDataAttributeValue

public Object getUserDataAttributeValue(String attributeURI)
                                 throws IMCException

To get the value of a user data attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the user data attribute.

Returns:

the value of the user data attribute as Object.

Throws:

IMCException

getUserDataAttributeValue1

public Object getUserDataAttributeValue1(String attributeURI)
                                  throws IMCException

To get the value of a user data attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the user data attribute.

Returns:

the value of the data attribute as Object.

Throws:

IMCException

getUserRelationAttributeErpId

public String getUserRelationAttributeErpId(String attributeURI)
                                     throws IMCException

To get the ERPID of a user relation attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the quote relation attribute.

Returns:

the ERPId of the user relation attribute as String.

Throws:

IMCException

getUserRelationAttributeObjectId

public String getUserRelationAttributeObjectId(String attributeURI)
                                        throws IMCException

To get the object Id of a user relation attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the user relation attribute.

Returns:

the objectId of the user relation attribute as String.

Throws:

IMCException

getUserRelationAttributeObjectName

public String getUserRelationAttributeObjectName(String attributeURI)
                                          throws IMCException

To get the object name of a user relation attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the user relation attribute.

Returns:

the object name of the user relation attribute as String.

Throws:

IMCException

getuserRelationAttributeURI

public String getuserRelationAttributeURI(String attributeURI)
                                   throws IMCException

To get the URI of a user relation attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the user relation attribute.

Returns:

the object URI of the user relation attribute as String.

Throws:

IMCException

getUserURI

public String getUserURI()

Retrieves the URI of this User

Returns:

The User URI as String

setUserDataAttribute

public User setUserDataAttribute(String attributeURI,
                                 Object value)
                          throws IMCException

To set a value for the user data attribute.

Parameters:

attributeURI - as String. The URI of the user data attribute.

value - as Object. The value for the user data attribute.

Returns:

The User instance.

Throws:

IMCException - the platform exception

setUserRelationAttribute

public User setUserRelationAttribute(String attributeURI,
                                     String valueURI)
                              throws IMCException

To set a value for the user relation attribute.

Parameters:

attributeURI - as String. The URI of the user relation attribute.

valueURI - as Object. The value for the user relation attribute.

Returns:

The User instance.

Throws:

IMCException - the platform exception