public class ManagedFolder extends JSBaseScriptableObject implements IFolderObject
Constructor and Description |
---|
ManagedFolder() |
Modifier and Type | Method and Description |
---|---|
void |
jsConstructor(java.lang.String theRelativePath)
Creates a managed folder instance.
|
java.lang.String |
jsFunction_getAbsolutePath()
Get the folder's absolute path.
|
FileAndFolderIterator |
jsFunction_getContents(int theDepth)
Gets all files and folders in the folder.
|
boolean |
jsFunction_isBundle()
Check if the folder is a bundle
|
void |
jsFunction_lock()
Creates a MediaBeacon-managed lock on this ManagedFolder.
|
void |
jsFunction_unlock()
Unlocks this managed folder.
|
Bundle |
jsGet_bundle()
Get the bundle control file for a folder
|
ManagedFolder[] |
jsGet_children()
Returns an array of managed folders that are direct children of this folder
|
int |
jsGet_directoryId() |
boolean |
jsGet_exists()
Checks if this folder exists on the server's file system.
|
java.lang.String |
jsGet_name()
Returns the name of the directory.
|
IFolderObject |
jsGet_parent()
Returns the parent directory.
|
java.lang.String |
jsGet_path()
Get the folder's path relative to the MediaBeacon asset root folder.
|
applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public void jsConstructor(java.lang.String theRelativePath) throws InvalidManagedFolderPathException
theRelativePath
- the path, relative to the MediaBeacon asset root, to a folder currently managed by MediaBeacon.
This path should contain unix-style file separators regardless of what file system hosts the assets.InvalidManagedFolderPathException
- if the folder is not found or isn't managed by MediaBeacon.public java.lang.String jsGet_path()
jsGet_path
in interface IFolderObject
public java.lang.String jsFunction_getAbsolutePath()
public void jsFunction_lock() throws com.brightech.mb.web.fs.ConcurentActionsException, java.lang.InterruptedException
com.brightech.mb.web.fs.ConcurentActionsException
- if unable to obtain a lock within the system property-configurable amount of time.
Also thrown if this ManagedFolder object is stale and the folder it references has been deleted, renamed or moved since
this ManagedFolder object was constructed.java.lang.InterruptedException
- if the thread was interrupted while waiting to obtain the lock.public void jsFunction_unlock()
public boolean jsGet_exists()
jsGet_exists
in interface IFolderObject
true
if the file or directory exists.public java.lang.String jsGet_name()
jsGet_name
in interface IFolderObject
public IFolderObject jsGet_parent()
jsGet_parent
in interface IFolderObject
IFileObject
represents parent file or directory.public ManagedFolder[] jsGet_children()
public boolean jsFunction_isBundle()
true
if the folder is a bundle, false
otherwisepublic Bundle jsGet_bundle()
public FileAndFolderIterator jsFunction_getContents(int theDepth)
theDepth
- the depth of the recursion, if it is not specified or null then the method returns all files and folders at any depth.public int jsGet_directoryId()
Copyright © 2023 MediaBeacon, Inc. All Rights Reserved.