definition_getLocalDefinitionByName

Syntax

public DefinitionBrief definition_getLocalDefinitionByName( String accessToken, long binderId, String name, boolean includeAncestors );

Description

The definition_getLocalDefinitionByname operation obtains information about a local definition by using a name. To get information about a global definition, use the definition_getDefinitionByname operation.

Parameters and Return Value

accessToken

Either the security token passed to your application by Vibe as part of implementing a remote application, or the null value.

binderId

The binder identifier for the workspace or folder whose local definition you want.

name

The word or phrase used to name the local definition.

includeAncestors

A Boolean value that indicates whether Vibe should check local definitions inherited from ancestor workspaces and folders, which are located higher in the hierarchy than the specified binder. If you specify false, Vibe checks only the local definitions created within the specified binder.

return_value

A DefinitionBrief Java object containing information about the definition that matches name.

See Also