eu.ehri.project.commands

Class EntityAdd

java.lang.Object

eu.ehri.project.commands.BaseCommand

eu.ehri.project.commands.EntityAdd

All Implemented Interfaces:

Command

public class EntityAdd
extends BaseCommand

Add a user.

Field Summary

Fields inherited from class eu.ehri.project.commands.BaseCommand

options

Constructor Summary

Constructors

Constructor and Description
EntityAdd()

Method Summary

Modifier and Type	Method and Description
void	createItem(com.tinkerpop.frames.FramedGraph<?> graph, org.apache.commons.cli.CommandLine cmdLine, String id, Bundle bundle, PermissionScope scope, UserProfile user, String logMessage)
int	execWithOptions(com.tinkerpop.frames.FramedGraph<?> graph, org.apache.commons.cli.CommandLine cmdLine) Execute this command with the given database and parsed command line arguments.
String	getHelp() Get information about the functionality of the command.
String	getUsage() Get a short hint about the usage of the command.
protected void	setCustomOptions(org.apache.commons.cli.Options options)

Methods inherited from class eu.ehri.project.commands.BaseCommand

api, exec, getDetailedHelp

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.ehri.project.commands.Command

getHelpFooter

Constructor Detail

EntityAdd

public EntityAdd()

Method Detail

setCustomOptions

protected void setCustomOptions(org.apache.commons.cli.Options options)

Overrides:

setCustomOptions in class BaseCommand

getUsage

public String getUsage()

Description copied from interface: Command

Get a short hint about the usage of the command.

Specified by:

getUsage in interface Command

Specified by:

getUsage in class BaseCommand

Returns:

a usage text

getHelp

public String getHelp()

Description copied from interface: Command

Get information about the functionality of the command.

Specified by:

getHelp in interface Command

Specified by:

getHelp in class BaseCommand

Returns:

a help text

execWithOptions

public int execWithOptions(com.tinkerpop.frames.FramedGraph<?> graph,
                           org.apache.commons.cli.CommandLine cmdLine)
                    throws ItemNotFound,
                           ValidationError,
                           PermissionDenied,
                           DeserializationError

Description copied from class: BaseCommand

Execute this command with the given database and parsed command line arguments.

Specified by:

execWithOptions in interface Command

Specified by:

execWithOptions in class BaseCommand

Parameters:

graph - the graph database

cmdLine - the parsed command line object

Returns:

a command return code

Throws:

ItemNotFound

ValidationError

PermissionDenied

DeserializationError

createItem

public void createItem(com.tinkerpop.frames.FramedGraph<?> graph,
                       org.apache.commons.cli.CommandLine cmdLine,
                       String id,
                       Bundle bundle,
                       PermissionScope scope,
                       UserProfile user,
                       String logMessage)
                throws DeserializationError,
                       ValidationError,
                       PermissionDenied

Throws:

DeserializationError

ValidationError

PermissionDenied