| com.tle.core.metadata.scripting.objects Interface MetadataScriptObject |
| Declaration: | public interface MetadataScriptObject extends ScriptObject |
| All Superinterfaces: |
ScriptObject,
java.io.Serializable
|
Referenced by the 'metadata' variable in a script
| Fields Summary | |
| static java.lang.String |
DEFAULT_VARIABLE
|
| Methods Summary | |
| abstract MetadataScriptType |
getMetadata(AttachmentScriptType a)
Returns a MetadataScriptType object for the attachment provided.
|
| abstract MetadataScriptType |
getMetadata(FileHandleScriptType f)
Returns a MetadataScriptType object for the file provided.
|
| Methods inherited from interface: com.tle.common.scripting.ScriptObject |
| scriptEnter, scriptExit |
| Fields Detail |
DEFAULT_VARIABLE
| public static final java.lang.String DEFAULT_VARIABLE |
| See also: | Constants |
| Methods Detail |
getMetadata
| public abstract MetadataScriptType getMetadata( | FileHandleScriptType f) |
Returns a
MetadataScriptType object for the file provided. If the
file does not exist or cannot be read an empty object will be returned.
| Parameters: | ||
|---|---|---|
| file | - |
|
| Returns: | |
| |
getMetadata
| public abstract MetadataScriptType getMetadata( | AttachmentScriptType a) |
Returns a
MetadataScriptType object for the attachment provided.
If the attachment type is unsupported an empty object will be returned
| Parameters: | ||
|---|---|---|
| attachment | - |
|
| Returns: | |
| |