com.marklogic.client.admin

Class ExtensionMetadata

java.lang.Object

com.marklogic.client.admin.ExtensionMetadata

public class ExtensionMetadata
extends Object

Extension Metadata provides detail about a transform or resource services extension. All of the detail is optional but recommended.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtensionMetadata.ScriptLanguage The ScriptLanguage enumeration specifies the categories of metadata read from or written to the database.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionMetadata.ScriptLanguage	JAVASCRIPT Convenience constant to provide something shorter than ExtensionMetadata.ScriptLanguage.JAVASCRIPT
static ExtensionMetadata.ScriptLanguage	XQUERY Convenience constant to provide something shorter than ExtensionMetadata.ScriptLanguage.XQUERY

Constructor Summary

Constructors

Constructor and Description
ExtensionMetadata() Zero-argument constructor.

Method Summary

Modifier and Type	Method and Description
RequestParameters	asParameters() Constructs request parameters expressing the extension metadata.
String	getDescription() Returns the description of the extension.
String	getProvider() Returns the name of the organization providing the extension.
ExtensionMetadata.ScriptLanguage	getScriptLanguage() Returns the script language for this resource extension, either XQUERY (default) or JAVASCRIPT.
String	getTitle() Returns the title of the extension.
String	getVersion() Returns the version identifier for the extension implementation.
void	setDescription(String description) Specifies the description of the extension.
void	setProvider(String provider) Specifies the name of the organization providing the extension.
void	setScriptLanguage(ExtensionMetadata.ScriptLanguage scriptLanguage) Specifies the script language for this resource extension, either XQUERY (default) or JAVASCRIPT.
void	setTitle(String title) Specifies the title of the extension.
void	setVersion(String version) Specifies the version identifier for the extension implementation.

Methods inherited from class java.lang.Object

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

Field Detail

XQUERY

public static final ExtensionMetadata.ScriptLanguage XQUERY

Convenience constant to provide something shorter than ExtensionMetadata.ScriptLanguage.XQUERY

JAVASCRIPT

public static final ExtensionMetadata.ScriptLanguage JAVASCRIPT

Convenience constant to provide something shorter than ExtensionMetadata.ScriptLanguage.JAVASCRIPT

Constructor Detail

ExtensionMetadata

public ExtensionMetadata()

Zero-argument constructor.

Method Detail

getTitle

public String getTitle()

Returns the title of the extension.

Returns:

the extension title

setTitle

public void setTitle(String title)

Specifies the title of the extension.

Parameters:

title - the extension title

getDescription

public String getDescription()

Returns the description of the extension.

Returns:

the extension description

setDescription

public void setDescription(String description)

Specifies the description of the extension.

Parameters:

description - the extension description

getProvider

public String getProvider()

Returns the name of the organization providing the extension.

Returns:

the provider name

setProvider

public void setProvider(String provider)

Specifies the name of the organization providing the extension.

Parameters:

provider - the provider name

getVersion

public String getVersion()

Returns the version identifier for the extension implementation.

Returns:

the version number or code

setVersion

public void setVersion(String version)

Specifies the version identifier for the extension implementation.

Parameters:

version - the version number or code

getScriptLanguage

public ExtensionMetadata.ScriptLanguage getScriptLanguage()

Returns the script language for this resource extension, either XQUERY (default) or JAVASCRIPT.

Returns:

the script language for this resource extension

setScriptLanguage

public void setScriptLanguage(ExtensionMetadata.ScriptLanguage scriptLanguage)

Specifies the script language for this resource extension, either XQUERY (default) or JAVASCRIPT.

Parameters:

scriptLanguage - the script language for this resource extension

asParameters

public RequestParameters asParameters()

Constructs request parameters expressing the extension metadata.

Ordinarily, this method is called internally during extension processing, but you can call this method directly if convenient.

Returns:

the metadata as parameters