Package de.elo.ix.client.subs

Class Substitution

java.lang.Object

byps.BValueClass

de.elo.ix.client.ValueClass

de.elo.ix.client.subs.Substitution

All Implemented Interfaces:

Serializable

public class Substitution
extends ValueClass

A Substitution is used to create, update and read substitutions.

Since:

12.00.000.029

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	access	The current users access rights for this Substitution.
protected int	creatorId	User who created the Substitution.
protected String	creatorName	User who created the Substitution.
protected List<Integer>	forwardedBy	If the substitution was forwarded by IXServicePortIF.forwardSubstitution(de.elo.ix.client.ClientInfo, de.elo.ix.client.subs.ForwardSubstitutionInfo, de.elo.ix.client.LockZ), the original substitutes (substituteId are saved here.
protected String	forwardedFrom	If a substitution was forwarded to an other one, this references the guid of the substitution it was forwarded from.
protected String	forwardedTo	If a substitution was forwarded to an other one, this references the guid of the substitution it was forwarded to.
protected List<Integer>	groupsToInheritRights	List of groups of which the substitute inherits the rights.
protected String	guid	GUID of substitution
protected int	lockId	User ID of the user that has locked the Substitution
protected String	lockName	Name of the user that has locked the Substitution
protected String	message	Message to add to the substitution.
protected SubstitutionSettings	settings	Contains all boolean settings for a Substitution
protected SubstitutionStatus	status	Returns the status of the substitution.
protected int	substituteId	User or group to whom the substitution is directed.
protected String	substituteName	User or group to whom the substitution is directed.
protected int	substituteType	Type of the substitute.
protected List<SubstitutionPeriod>	substitutionPeriods	List of time periods in which the substitution is activated automatically if SubstitutionSettings.activatePeriodsAutomatically is set to true.
protected String	tstamp	Timestamp of last update.
protected String	tstampsync	Timestamp of last update.
protected int	userId	The user or group which is substituted by this object.
protected String	userName	The user or group which is substituted by this object.

Fields inherited from class byps.BValueClass

bypsClient, changedMembers, dbHelper, FLAG_SEALED, flags

Constructor Summary

Constructors

Constructor	Description
Substitution()
Substitution(Substitution rhs)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getAccess()
int	getCreatorId()
String	getCreatorName()
List<Integer>	getForwardedBy()
String	getForwardedFrom()
String	getForwardedTo()
List<Integer>	getGroupsToInheritRights()
String	getGuid()
int	getLockId()
String	getLockName()
String	getMessage()
SubstitutionSettings	getSettings()
SubstitutionStatus	getStatus()
int	getSubstituteId()
String	getSubstituteName()
int	getSubstituteType()
List<SubstitutionPeriod>	getSubstitutionPeriods()
String	getTstamp()
String	getTstampsync()
int	getUserId()
String	getUserName()
int	hashCode()
void	setAccess(int access)
void	setCreatorId(int creatorId)
void	setCreatorName(String creatorName)
void	setForwardedBy(List<Integer> forwardedBy)
void	setForwardedFrom(String forwardedFrom)
void	setForwardedTo(String forwardedTo)
void	setGroupsToInheritRights(List<Integer> groupsToInheritRights)
void	setGuid(String guid)
void	setLockId(int lockId)
void	setLockName(String lockName)
void	setMessage(String message)
void	setSettings(SubstitutionSettings settings)
void	setStatus(SubstitutionStatus status)
void	setSubstituteId(int substituteId)
void	setSubstituteName(String substituteName)
void	setSubstituteType(int substituteType)
void	setSubstitutionPeriods(List<SubstitutionPeriod> substitutionPeriods)
void	setTstamp(String tstamp)
void	setTstampsync(String tstampsync)
void	setUserId(int userId)
void	setUserName(String userName)
String	toString()

Methods inherited from class byps.BValueClass

getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

guid

protected String guid

GUID of substitution

A new substitution is saved if guid is empty on checkin. An existing substitution is updated if a guid is provided.

userId

protected int userId

The user or group which is substituted by this object.

This variable is ignored when calling IXServicePortIF.checkinSubstitutions(de.elo.ix.client.ClientInfo, de.elo.ix.client.subs.CheckinSubstitutionsInfo, de.elo.ix.client.subs.SubstitutionZ, de.elo.ix.client.LockZ) if userName is set.

userName

protected String userName

The user or group which is substituted by this object.

userId is ignored if this member is set when calling IXServicePortIF.checkinSubstitutions(de.elo.ix.client.ClientInfo, de.elo.ix.client.subs.CheckinSubstitutionsInfo, de.elo.ix.client.subs.SubstitutionZ, de.elo.ix.client.LockZ).

substituteId

protected int substituteId

User or group to whom the substitution is directed.

This variable is ignored when calling IXServicePortIF.checkinSubstitutions(de.elo.ix.client.ClientInfo, de.elo.ix.client.subs.CheckinSubstitutionsInfo, de.elo.ix.client.subs.SubstitutionZ, de.elo.ix.client.LockZ) if substituteName is set.

substituteName

protected String substituteName

User or group to whom the substitution is directed.

substituteId is ignored if this member is set when calling IXServicePortIF.checkinSubstitutions(de.elo.ix.client.ClientInfo, de.elo.ix.client.subs.CheckinSubstitutionsInfo, de.elo.ix.client.subs.SubstitutionZ, de.elo.ix.client.LockZ).

substituteType

protected int substituteType

Type of the substitute.

Read-only, refers to UserInfoC.TYPE_GROUP or UserInfoC.TYPE_USER

creatorId

protected int creatorId

User who created the Substitution. Read-only.

creatorName

protected String creatorName

User who created the Substitution. Read-only.

access

protected int access

The current users access rights for this Substitution. Returns a combination of AccessC.LUR_ constants. Read-only.

Since:

20.00.000.111

groupsToInheritRights

protected List<Integer> groupsToInheritRights

List of groups of which the substitute inherits the rights.

It is not possible to inherit rights from a user, only from groups. Every group needs to have the the right AccessC.FLAG2_CAN_BE_SUBSTITUTED

substitutionPeriods

protected List<SubstitutionPeriod> substitutionPeriods

List of time periods in which the substitution is activated automatically if SubstitutionSettings.activatePeriodsAutomatically is set to true.

settings

protected SubstitutionSettings settings

Contains all boolean settings for a Substitution

status

protected SubstitutionStatus status

Returns the status of the substitution.

In case of checking in a substitution, this variable is ignored.

forwardedTo

protected String forwardedTo

If a substitution was forwarded to an other one, this references the guid of the substitution it was forwarded to.

Read-only.

forwardedFrom

protected String forwardedFrom

If a substitution was forwarded to an other one, this references the guid of the substitution it was forwarded from.

Read-only.

message

protected String message

Message to add to the substitution.

lockId

protected int lockId

User ID of the user that has locked the Substitution

If -1, no lock is held. Read-only, ignored in IXServicePortIF.checkinSubstitutions(de.elo.ix.client.ClientInfo, de.elo.ix.client.subs.CheckinSubstitutionsInfo, de.elo.ix.client.subs.SubstitutionZ, de.elo.ix.client.LockZ)

lockName

protected String lockName

Name of the user that has locked the Substitution

Read-only, ignored in IXServicePortIF.checkinSubstitutions(de.elo.ix.client.ClientInfo, de.elo.ix.client.subs.CheckinSubstitutionsInfo, de.elo.ix.client.subs.SubstitutionZ, de.elo.ix.client.LockZ)

tstamp

protected String tstamp

Timestamp of last update. Read-only.

tstampsync

protected String tstampsync

Timestamp of last update. Read-only.

forwardedBy

protected List<Integer> forwardedBy

If the substitution was forwarded by IXServicePortIF.forwardSubstitution(de.elo.ix.client.ClientInfo, de.elo.ix.client.subs.ForwardSubstitutionInfo, de.elo.ix.client.LockZ), the original substitutes (substituteId are saved here. Read-only

Since:

12.00.000.047

Constructor Details

Substitution

public Substitution()

Substitution

public Substitution(Substitution rhs)

Method Details

getGuid

public String getGuid()

setGuid

public void setGuid(String guid)

getUserId

public int getUserId()

setUserId

public void setUserId(int userId)

getUserName

public String getUserName()

setUserName

public void setUserName(String userName)

getSubstituteId

public int getSubstituteId()

setSubstituteId

public void setSubstituteId(int substituteId)

getSubstituteName

public String getSubstituteName()

setSubstituteName

public void setSubstituteName(String substituteName)

getGroupsToInheritRights

public List<Integer> getGroupsToInheritRights()

setGroupsToInheritRights

public void setGroupsToInheritRights(List<Integer> groupsToInheritRights)

getSubstitutionPeriods

public List<SubstitutionPeriod> getSubstitutionPeriods()

setSubstitutionPeriods

public void setSubstitutionPeriods(List<SubstitutionPeriod> substitutionPeriods)

getAccess

public int getAccess()

setAccess

public void setAccess(int access)

getStatus

public SubstitutionStatus getStatus()

setStatus

public void setStatus(SubstitutionStatus status)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getLockId

public int getLockId()

setLockId

public void setLockId(int lockId)

getLockName

public String getLockName()

setLockName

public void setLockName(String lockName)

getCreatorId

public int getCreatorId()

setCreatorId

public void setCreatorId(int creatorId)

getCreatorName

public String getCreatorName()

setCreatorName

public void setCreatorName(String creatorName)

getForwardedTo

public String getForwardedTo()

setForwardedTo

public void setForwardedTo(String forwardedTo)

getForwardedFrom

public String getForwardedFrom()

setForwardedFrom

public void setForwardedFrom(String forwardedFrom)

getTstamp

public String getTstamp()

setTstamp

public void setTstamp(String tstamp)

getSettings

public SubstitutionSettings getSettings()

setSettings

public void setSettings(SubstitutionSettings settings)

getTstampsync

public String getTstampsync()

setTstampsync

public void setTstampsync(String tstampsync)

getSubstituteType

public int getSubstituteType()

setSubstituteType

public void setSubstituteType(int substituteType)

getForwardedBy

public List<Integer> getForwardedBy()

setForwardedBy

public void setForwardedBy(List<Integer> forwardedBy)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object