com.sas.hls.resource.repository
Class RepositoryFileInfo

java.lang.Object
  extended by com.sas.hls.resource.repository.RepositoryFileInfo
All Implemented Interfaces:
Serializable

public class RepositoryFileInfo
extends Object
implements Serializable

Provides the latest repository file information related to synchronization state. This provides the user with information about the file which currently resides in the repository, independent of what the user has synchronized to their workspace, if they have synchronized the file to their workspace.

Since:
1.7
See Also:
RepositoryResourceService.getSynchronizationInfo(String), SynchronizationInfo.getRepositoryFileInfo(), Serialized Form

Constructor Summary
RepositoryFileInfo(String identifier, String path, String version, Date lastModifiedDate, long size, boolean checkedOut, String checkedOutBy)
          Initializing constructor which sets the values of all variables.
 
Method Summary
 boolean equals(Object obj)
          Indicate whether some other object is "equal to" this one.
 String getCheckedOutBy()
          Returns who has this repository file checked out, if it is checked out.
 String getIdentifier()
          Returns the unique identifier of this repository file.
 Date getLastModifiedDate()
          Returns the last date this repository file was modified.
 String getPath()
          Returns the full path of this repository file.
 long getSize()
          Returns the size of this repository file (in bytes).
 String getVersion()
          Returns the latest version of this repository file.
 int hashCode()
          Return a hash code value for the object.
 boolean isCheckedOut()
          Is this repository file currently checked out?
 String toString()
          Return a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RepositoryFileInfo

public RepositoryFileInfo(String identifier,
                          String path,
                          String version,
                          Date lastModifiedDate,
                          long size,
                          boolean checkedOut,
                          String checkedOutBy)
Initializing constructor which sets the values of all variables.

It is not intended or recommended that the consumer of the API construct these objects. They should only be retrieved from service calls such as RepositoryResourceService.getSynchronizationInfo(String).

Parameters:
identifier - The unique identifier for the repository file.
path - The full path of the repository file.
version - The version of the repository file.
lastModifiedDate - The date the repository file was last modified.
size - The size of the repository file.
checkedOut - Whether this repository is checked out.
checkedOutBy - If this repository file is checked out, who has it checked out.
Method Detail

getIdentifier

public String getIdentifier()
Returns the unique identifier of this repository file.

Returns:
The unique identifier of this repository file.

getPath

public String getPath()
Returns the full path of this repository file.

Returns:
The full path of this repository file.

getVersion

public String getVersion()
Returns the latest version of this repository file.

Returns:
The latest version of this repository file.

getLastModifiedDate

public Date getLastModifiedDate()
Returns the last date this repository file was modified.

Returns:
The last date this repository file was modified.

getSize

public long getSize()
Returns the size of this repository file (in bytes).

Returns:
The size of this repository file (in bytes).

isCheckedOut

public boolean isCheckedOut()
Is this repository file currently checked out?

Returns:
true if this repository file is currently checked out, false otherwise.

getCheckedOutBy

public String getCheckedOutBy()
Returns who has this repository file checked out, if it is checked out.

Returns:
The userid of the user who has the file checked out, if the file is not checked out this will return null.

hashCode

public int hashCode()
Return a hash code value for the object.

Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)
Indicate whether some other object is "equal to" this one.

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

toString

public String toString()
Return a string representation of the object.

Overrides:
toString in class Object
See Also:
Object.toString()


Copyright (c) 2014, SAS Institute Inc., Cary, NC, USA