org.alfresco.wcm.sandbox.script

Class Asset

java.lang.Object

org.alfresco.wcm.sandbox.script.Asset

All Implemented Interfaces:

Serializable

public class Asset
extends Object
implements Serializable

WCM Asset in a sandbox exposed over Java Script API.

Author:

mrogers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Asset(Sandbox sandbox, AssetInfo asset)

Method Summary

Methods

Modifier and Type	Method and Description
void	createFile(String name, String stringContent) create a new file with the specified properties and content.
void	createFolder(String name) create a new folder
void	deleteAsset() Delete this asset, after it has been deleted do not use this asset.
Asset[]	getChildren() Get children of this asset, returns an empty array if there are no children.
String	getContent() Returns textual representation of the Asset content
Date	getCreatedDate()
String	getCreatedDateAsISO8601()
String	getCreator() The creator of this asset
long	getFileSize()
Date	getModifiedDate()
String	getModifiedDateAsISO8601()
String	getModifier()
String	getName()
String	getPath() Get the full path of this asset eg.
Map<String,String>	getProperties() Get the properties as a key value pair.
Sandbox	getSandbox() Get the parent sandbox which contains this asset
int	getVersion()
boolean	isDeleted()
boolean	isFile()
boolean	isFolder()
boolean	isLocked()
String	lockOwner()
Asset	move(String newPath) move this asset
Asset	rename(String newName) rename this asset
void	revert() revert this asset
void	save() Save the properties please note some system properties are protected and cannot be updated.
void	setProperties(Object nativeProperties)
void	submit(String submitLabel, String submitComment) Submit this asset to staging
boolean	writeContent(org.springframework.extensions.surf.util.Content content) Updates a content of the current Asset
boolean	writeContent(String content) Updates a content of a current Asset

Methods inherited from class java.lang.Object

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

Constructor Detail

Asset

public Asset(Sandbox sandbox,
     AssetInfo asset)

Method Detail

getCreator

public String getCreator()

The creator of this asset

Returns:

the creator

getCreatedDate

public Date getCreatedDate()

getFileSize

public long getFileSize()

getCreatedDateAsISO8601

public String getCreatedDateAsISO8601()

getModifier

public String getModifier()

getModifiedDate

public Date getModifiedDate()

getModifiedDateAsISO8601

public String getModifiedDateAsISO8601()

rename

public Asset rename(String newName)

rename this asset

Parameters:

newName -

move

public Asset move(String newPath)

move this asset

Parameters:

newPath -

getName

public String getName()

getPath

public String getPath()

Get the full path of this asset eg. /www/avm_webapps/ROOT/myFile.jpg

Returns:

the path of this asset.

isFile

public boolean isFile()

isFolder

public boolean isFolder()

isDeleted

public boolean isDeleted()

isLocked

public boolean isLocked()

lockOwner

public String lockOwner()

getVersion

public int getVersion()

getProperties

public Map<String,String> getProperties()

Get the properties as a key value pair. The key will be either a local qname e.g. "cm:content" or a global qname e.g. "{http://www.alfresco.com/content/1.0}content". Some properties will be updatable, protected properties are not.

Returns:

the properties in a key, value pair

save

public void save()

Save the properties please note some system properties are protected and cannot be updated. If you attempt to update a protected property your request will be ignored.

Parameters:

properties -

setProperties

public void setProperties(Object nativeProperties)
                   throws org.json.JSONException

Parameters:

properties -

Throws:

org.json.JSONException

writeContent

public boolean writeContent(String content)

Updates a content of a current Asset

Parameters:

content - String value which represents new textual content

Returns:

true if a content has been set without errors

writeContent

public boolean writeContent(org.springframework.extensions.surf.util.Content content)

Updates a content of the current Asset

Parameters:

content - a Content value which represents new content

Returns:

true if a content has been set without errors

getContent

public String getContent()
                  throws org.alfresco.service.cmr.repository.ContentIOException,
                         IOException

Returns textual representation of the Asset content

Returns:

content as a text

Throws:

org.alfresco.service.cmr.repository.ContentIOException

IOException

submit

public void submit(String submitLabel,
          String submitComment)

Submit this asset to staging

Parameters:

submitLabel -

submitComment -

deleteAsset

public void deleteAsset()

Delete this asset, after it has been deleted do not use this asset.

revert

public void revert()

revert this asset

getChildren

public Asset[] getChildren()

Get children of this asset, returns an empty array if there are no children. Only folders have children.

createFile

public void createFile(String name,
              String stringContent)

create a new file with the specified properties and content.

Parameters:

name - the name of the file

stringContent - the content of the file. Can be null.

createFolder

public void createFolder(String name)

create a new folder

Parameters:

name - the name of the new folder

getSandbox

public Sandbox getSandbox()

Get the parent sandbox which contains this asset

Returns:

the parent sandbox which contains this asset