jb.gwt_main_modules.base_widgets.client.js_api

Class MetadataApiPublisher

java.lang.Object

jb.gwt_main_modules.base_widgets.client.js_api.MetadataApiPublisher

All Implemented Interfaces:

jb.gwt_main_modules.base_widgets.client.services.proxy.ActionResolverConstants

public class MetadataApiPublisher
extends java.lang.Object
implements jb.gwt_main_modules.base_widgets.client.services.proxy.ActionResolverConstants

JS methods exposed to read/write metadata, or show editting dialogs.

All methods are located in a sub object at window.MBAPI.md

(window.MBAPI.md.setField(theCallback, theAssetId, theNamespace, theField, theValue, theFieldType, theAction) for example)

Field Summary

Fields inherited from interface jb.gwt_main_modules.base_widgets.client.services.proxy.ActionResolverConstants

kAutoCompleteParameter, kCreateAssetType, kDownloadBundle, kINDDType, kKeyValueSeparator, kLoadingDockProgressID, kLoadingDockUserName, kLocationToken, kParamSeparator, kSavedSearchType, kSearchParameters, kSearchToken, kSearchType, kSelectionLocked, kSolrWait, kSQLType, kTab_id_key, kTypeSeparator, kWidget_id_key

Constructor Summary

Constructors

Constructor and Description
MetadataApiPublisher()

Method Summary

Modifier and Type	Method and Description
static void	batchSetField(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback, int theAssetId, com.google.gwt.core.client.JsArrayString theNamespace, com.google.gwt.core.client.JsArrayString theField, com.google.gwt.core.client.JsArrayString theValue, com.google.gwt.core.client.JsArrayString theFieldType, com.google.gwt.core.client.JsArrayString theAction) Set metadata for multiple fields in one method for a specific asset based on asset ID.
static void	batchSetFieldByResolver(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback, java.lang.String theResolverUrl, com.google.gwt.core.client.JsArrayString theNamespace, com.google.gwt.core.client.JsArrayString theField, com.google.gwt.core.client.JsArrayString theValue, com.google.gwt.core.client.JsArrayString theFieldType, com.google.gwt.core.client.JsArrayString theAction) Set metadata for multiple fields in one method, supporting both single and multiple assets based on the resolver URL.
static void	doGetField(com.google.gwt.core.client.JavaScriptObject theCallback, com.google.gwt.core.client.JsArrayInteger theAssetId, com.google.gwt.core.client.JsArrayString theArrayString)
static void	getAssetsFieldValue(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback, com.google.gwt.core.client.JsArrayInteger theAssetIds, java.lang.String theNamespace, java.lang.String theField) Deprecated.
static void	getField(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback, com.google.gwt.core.client.JsArrayInteger theAssetIds, com.google.gwt.core.client.JsArrayString theFieldIds) Get metadata for a specific asset
static void	getFieldsForNamespace(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback, int theAssetId, java.lang.String theNamespace) Deprecated.
static void	setField(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback, int theAssetId, java.lang.String theNamespace, java.lang.String theField, java.lang.String theValue, java.lang.String theFieldType, java.lang.String theAction) Can set the metadata of a specific asset
static void	setupJavascriptAPIs()
static void	showBulkEditDialog() Show the bulk edit dialog

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataApiPublisher

public MetadataApiPublisher()

Method Detail

setupJavascriptAPIs

public static void setupJavascriptAPIs()

doGetField

public static void doGetField(com.google.gwt.core.client.JavaScriptObject theCallback,
                              com.google.gwt.core.client.JsArrayInteger theAssetId,
                              com.google.gwt.core.client.JsArrayString theArrayString)

getField

public static void getField(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback,
                            com.google.gwt.core.client.JsArrayInteger theAssetIds,
                            com.google.gwt.core.client.JsArrayString theFieldIds)

Get metadata for a specific asset

Parameters:

theCallback - the function to return the string value to

theAssetIds - the asset ids

theFieldIds - the metadata field ids

getFieldsForNamespace

@Deprecated
public static void getFieldsForNamespace(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback,
                                                      int theAssetId,
                                                      java.lang.String theNamespace)

Deprecated.

getAssetsFieldValue

@Deprecated
public static void getAssetsFieldValue(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback,
                                                    com.google.gwt.core.client.JsArrayInteger theAssetIds,
                                                    java.lang.String theNamespace,
                                                    java.lang.String theField)

Deprecated.

Get values for a field for multiple assets

Parameters:

theCallback - the javascript object to return results to

theAssetIds - list of asset ids to get values for

theNamespace - the namespace to use

theField - the field to look up

setField

public static void setField(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback,
                            int theAssetId,
                            java.lang.String theNamespace,
                            java.lang.String theField,
                            java.lang.String theValue,
                            java.lang.String theFieldType,
                            java.lang.String theAction)

Can set the metadata of a specific asset

Parameters:

theCallback - the function that is called once the set action is complete

theAssetId - the asset id to set the metadata to

theNamespace - the metadata namespace

theField - the metadata field name

theValue - the value to set

theFieldType - the field type (txt, bag, seq, etc). This param is optional

theAction - the action type (add, delete, clear_field, replace_selected). This param is optional

batchSetField

public static void batchSetField(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback,
                                 int theAssetId,
                                 com.google.gwt.core.client.JsArrayString theNamespace,
                                 com.google.gwt.core.client.JsArrayString theField,
                                 com.google.gwt.core.client.JsArrayString theValue,
                                 com.google.gwt.core.client.JsArrayString theFieldType,
                                 com.google.gwt.core.client.JsArrayString theAction)

Set metadata for multiple fields in one method for a specific asset based on asset ID.

Example code:

 var anAssetId = 345345;
 var aNamespaces = new Array();
 var aFieldNames = new Array();
 var aValues = new Array();
 var aFieldTypes = new Array();
 var anActions = new Array();
 aNamespaces[0] = "http://mediabeacon.com/example/";
 aFieldNames[0] = "testField";
 aValues[0] = "first value";
 aFieldTypes[0] = "Txt";
 anActions[0] = "replace_selected";
 aNamespaces[1] = "http://mediabeacon.com/example/";
 aFieldNames[1] = "sampleField";
 aValues[1] = "another keyword";
 aFieldTypes[1] = "Txt";
 anActions[1] = "replace_selected";
 window.MBAPI.md.batchSetField(function(){}, anAssetId, aNamespaces, aFieldNames, aValues, aFieldTypes, anActions);
 

Parameters:

theCallback - function to inform when done

theAssetId - the asset id to set against

theNamespace - the namespaces

theField - the fields

theValue - values to set

theFieldType - the field type of the field (txt, bag, etc) (optional)

theAction - the action to perform (replace_selected, delete, etc) (optional)

batchSetFieldByResolver

public static void batchSetFieldByResolver(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback,
                                           java.lang.String theResolverUrl,
                                           com.google.gwt.core.client.JsArrayString theNamespace,
                                           com.google.gwt.core.client.JsArrayString theField,
                                           com.google.gwt.core.client.JsArrayString theValue,
                                           com.google.gwt.core.client.JsArrayString theFieldType,
                                           com.google.gwt.core.client.JsArrayString theAction)

Set metadata for multiple fields in one method, supporting both single and multiple assets based on the resolver URL.

Example code:

 var aResolverString = MBAPI.resolver.currentSelectionURL();
 var aNamespaces = new Array();
 var aFieldNames = new Array();
 var aValues = new Array();
 var aFieldTypes = new Array();
 var anActions = new Array();
 aNamespaces[0] = "http://mediabeacon.com/example/";
 aFieldNames[0] = "testField";
 aValues[0] = "first value";
 aFieldTypes[0] = "Txt";
 anActions[0] = "replace_selected";
 aNamespaces[1] = "http://mediabeacon.com/example/";
 aFieldNames[1] = "sampleField";
 aValues[1] = "another keyword";
 aFieldTypes[1] = "Txt";
 anActions[1] = "replace_selected";
 window.MBAPI.md.batchSetFieldByResolver(function(){}, aResolverString, aNamespaces, aFieldNames, aValues, aFieldTypes, anActions);
 

Parameters:

theCallback - function to inform when done

theResolverUrl - the resolver url to define selection to apply to

theNamespace - the namespaces

theField - the fields

theValue - values to set

theFieldType - the field type of the field (txt, bag, etc) (optional)

theAction - the action to perform (replace_selected, delete, etc) (optional)

showBulkEditDialog

public static final void showBulkEditDialog()

Show the bulk edit dialog