org.opencms.lock

Class CmsLockUtil.LockedFile

java.lang.Object

org.opencms.lock.CmsLockUtil.LockedFile

Enclosing class:

CmsLockUtil

public static final class CmsLockUtil.LockedFile
extends java.lang.Object

Helper to handle the lock reports together with the files.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEncoding() Returns the encoding used for the file.
CmsFile	getFile() Returns the file.
CmsLockActionRecord	getLockActionRecord() Returns the lock action record.
boolean	isCreated() Returns a flag, indicating if the file is newly created.
static CmsLockUtil.LockedFile	lockResource(CmsObject cms, CmsResource resource) Lock and read a file.
void	setCreated(boolean isNew) Set the flag, indicating if the file was newly created.
boolean	unlock()

Methods inherited from class java.lang.Object

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

Method Detail

lockResource

public static CmsLockUtil.LockedFile lockResource(CmsObject cms,
                                                  CmsResource resource)
                                           throws CmsException

Lock and read a file.

Parameters:

cms - the cms user context.

resource - the resource to lock and read.

Returns:

the read file with the lock action record.

Throws:

CmsException - thrown if locking fails

getEncoding

public java.lang.String getEncoding()

Returns the encoding used for the file.

Returns:

the encoding used for the file.

See Also:

CmsFileUtil.getEncoding(CmsObject, CmsResource)

getFile

public CmsFile getFile()

Returns the file.

Returns:

the file.

getLockActionRecord

public CmsLockActionRecord getLockActionRecord()

Returns the lock action record.

Returns:

the lock action record.

isCreated

public boolean isCreated()

Returns a flag, indicating if the file is newly created.

Returns:

flag, indicating if the file is newly created.

setCreated

public void setCreated(boolean isNew)

Set the flag, indicating if the file was newly created.

Parameters:

isNew - flag, indicating if the file was newly created.

unlock

public boolean unlock()
               throws CmsException

Throws:

CmsException