Primavera Integration API 6.1

com.primavera.integration.collab
Class CheckInOptions

java.lang.Object
  extended by com.primavera.integration.collab.CheckInOptions
All Implemented Interfaces:
Serializable

public class CheckInOptions
extends Object
implements Serializable

Contains options used when checking documents into the document management system.

See Also:
Serialized Form

Constructor Summary
CheckInOptions()
          Creates a CheckInOptions object with the defaults.
 
Method Summary
 boolean equals(Object obj)
          Determines if the input object is the same as the current object.
 String getComments()
          Gets the comments for the checkin options.
 boolean getKeepCheckedOut()
          Get the value of keep checked out option.
 boolean getOverWriteVersion()
          Get the value of the overwrite version option.
 int hashCode()
          Returns the hashCode for this object
 boolean isValid()
          Checks if all options are valid.
 void setComments(String comments)
          Sets the comments for the checkin options.
 void setDefaultOptions()
          Sets all values to their defaults.
 void setKeepCheckedOut(boolean value)
          Sets the option for keeping the file checked out.
 void setOverWriteVersion(boolean value)
          Sets the option for overwriting the version.
 String toString()
          The string representation of the object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CheckInOptions

public CheckInOptions()
Creates a CheckInOptions object with the defaults.

Method Detail

setDefaultOptions

public final void setDefaultOptions()
Sets all values to their defaults.


isValid

public boolean isValid()
Checks if all options are valid.

Returns:
true if all data passes validation conditions.

getKeepCheckedOut

public boolean getKeepCheckedOut()
Get the value of keep checked out option.

Returns:
value of the option

getOverWriteVersion

public boolean getOverWriteVersion()
Get the value of the overwrite version option.

Returns:
value of the option

setKeepCheckedOut

public void setKeepCheckedOut(boolean value)
Sets the option for keeping the file checked out.

Parameters:
value - to set

setOverWriteVersion

public void setOverWriteVersion(boolean value)
Sets the option for overwriting the version.

Parameters:
value - the value to set

getComments

public String getComments()
Gets the comments for the checkin options.

Returns:
comments as set

setComments

public void setComments(String comments)
Sets the comments for the checkin options.

Parameters:
comments - the comments to use on checkin
Throws:
IllegalArgumentException - if the input parameter is null or invalid

toString

public String toString()
The string representation of the object.

Overrides:
toString in class Object
Returns:
the string representation of this object.

hashCode

public int hashCode()
Returns the hashCode for this object

Overrides:
hashCode in class Object
Returns:
the hashCode

equals

public boolean equals(Object obj)
Determines if the input object is the same as the current object.

Overrides:
equals in class Object
Parameters:
obj -
Returns:
true if values are equivalent.

Primavera Integration API 6.1

Copyright © Primavera 1999-2007. All rights reserved.