stanford.netdb

Class Consultant

java.lang.Object

stanford.netdb.logging.NetDB_Logger

stanford.netdb.Attribute<T>

stanford.netdb.NetDB<T>

stanford.netdb.Record<Person>

stanford.netdb.Person

stanford.netdb.Consultant

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Person>, java.util.Comparator<Person>

public final class Consultant
extends Person

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class stanford.netdb.Person

Person.COMPARE_TYPE

Nested classes/interfaces inherited from class stanford.netdb.NetDB

NetDB.FORMAT

Nested classes/interfaces inherited from class stanford.netdb.Attribute

Attribute.COMPARISON_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JSON_PRIMARY
static java.lang.String	json_template_name The template toJSON uses.
static java.lang.String	template_name The template toString uses.

Fields inherited from class stanford.netdb.Person

JSON_ACTIVE, JSON_DIR_ACTIVE, JSON_DIRID, JSON_EMAIL, JSON_LAST_NAME, JSON_NAME, JSON_NETID, JSON_PHONE, JSON_REGID, name_comparator, regid_comparator

Fields inherited from class stanford.netdb.NetDB

extra_data, UNPROCESSED_JSON

Constructor Summary

Constructors

Constructor and Description
Consultant()
Consultant(NetDB_Datastore datastore)
Consultant(NetDB_Datastore datastore, Person person, java.lang.Boolean primary)
Consultant(Person person, java.lang.Boolean primary)

Method Summary

Modifier and Type	Method and Description
Consultant	clear_primary() Set the primary state to false.
Person	commit(NetDB_Datastore datastore) This class cannot currently be committed.
java.lang.String	handle() This is the unique identifier used in the database to identify a record.
java.lang.Boolean	is_primary() Fetch the primary state.
java.lang.String	name_and_primary_string() Return the name and denote whether or not the consultant is the primary (if it is primary, a star (*) will appear after their name).
Consultant	primary(java.lang.Boolean primary) Set the primary state.
Consultant	set_primary() Set the primary state to true.
java.lang.String	single_value_attributes() This method builds a String of all the single value attributes.
java.lang.String	toJSON(java.lang.Boolean pretty, java.lang.Boolean ignore_exceptions) Convert this to a JSON object using the template defined in json_template_name.
java.lang.String	toString(NetDB.FORMAT format, java.lang.Boolean ignore_exceptions) Convert this to a String using the template defined in template_name.

Methods inherited from class stanford.netdb.Person

_insert_or_update, _load_object, _verify_or_die, active, compare, compare, compareTo, delete, delete, delete, dir_id, dirID, email, id, last_name, lastname, load, load, load, load, name, netid, netID, new_instance, phone, reg_id, regID, sort_comparator, unlink

Methods inherited from class stanford.netdb.Record

commit, delete

Methods inherited from class stanford.netdb.NetDB

autocomplete, autocomplete, bind, clear_extra_data, compare, compare, complete, created_by_user, datastore, default_datastore, default_datastore, defined_or_die_handle, defined_or_die, equals, extra_data, extra_data, extra_data, fromJSON, is_bound, is_complete, is_partial, json_recovery_log, reset_timing, rmi_exception, timing, toJSON, toJSON, toJSON, toJSON, toString, toString, toString, toString, unbind, unique_identifier, version

Methods inherited from class stanford.netdb.logging.NetDB_Logger

backup_logger, backup_logger, default_logger, default_logger, entered, entered, entered, exited, exited, exited, get_method_name, log_enter_exit, log_message, logger, logger

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

template_name

public static java.lang.String template_name

The template toString uses.

json_template_name

public static java.lang.String json_template_name

The template toJSON uses.

JSON_PRIMARY

public static final java.lang.String JSON_PRIMARY

See Also:

Constant Field Values

Constructor Detail

Consultant

public Consultant()

Consultant

public Consultant(Person person,
                  java.lang.Boolean primary)

Consultant

public Consultant(NetDB_Datastore datastore)

Consultant

public Consultant(NetDB_Datastore datastore,
                  Person person,
                  java.lang.Boolean primary)

Method Detail

is_primary

public java.lang.Boolean is_primary()
                             throws java.lang.Exception,
                                    No_Datastore_Defined,
                                    Insufficient_Information

Fetch the primary state. If it is not present, and this instance is capable of being autocompleted, then this instance will be loaded and the value returned.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

See Also:

NetDB.internal_complete(java.lang.Object, java.lang.Object, java.lang.String)

handle

public java.lang.String handle()

Description copied from class: NetDB

This is the unique identifier used in the database to identify a record. Most of the time this is the "name" of the record.

Overrides:

handle in class Person

primary

public Consultant primary(java.lang.Boolean primary)

Set the primary state.

set_primary

public Consultant set_primary()

Set the primary state to true.

clear_primary

public Consultant clear_primary()

Set the primary state to false.

single_value_attributes

public java.lang.String single_value_attributes()

Description copied from class: Attribute

This method builds a String of all the single value attributes. The resulting String is used in compare (...) and is not meant to be parsed by users of this library.

Overrides:

single_value_attributes in class Person

See Also:

Attribute.compare(Attribute), Attribute.compare(Attribute,COMPARISON_TYPE)

toString

public java.lang.String toString(NetDB.FORMAT format,
                                 java.lang.Boolean ignore_exceptions)
                          throws java.lang.Exception

Convert this to a String using the template defined in template_name.

Overrides:

toString in class Person

Throws:

java.lang.Exception

toJSON

public java.lang.String toJSON(java.lang.Boolean pretty,
                               java.lang.Boolean ignore_exceptions)
                        throws java.lang.Exception

Convert this to a JSON object using the template defined in json_template_name.

Overrides:

toJSON in class Person

Throws:

java.lang.Exception

name_and_primary_string

public java.lang.String name_and_primary_string()
                                         throws java.lang.Exception

Return the name and denote whether or not the consultant is the primary (if it is primary, a star (*) will appear after their name).

Throws:

java.lang.Exception

commit

public Person commit(NetDB_Datastore datastore)
              throws Not_Implemented

This class cannot currently be committed. This will always throw a Not_Implemented exception.

Overrides:

commit in class Person

Throws:

Not_Implemented