/**
* An interface for addressbook contact manager
- *
+ * <p>
* @author Roland Haeder
*/
public interface ManageableContactAddressbook extends Manageable {
+
/**
* Allows the user to enter own cellphone number.
- *
+ * <p>
* @return Cellphone number
*/
public String enterOwnCellNumber ();
/**
* Allows the user to enter own city name.
- *
+ * <p>
* @return City name
*/
public String enterOwnCity ();
/**
* Allows the user to enter comment for own entry.
- *
+ * <p>
* @return Comment
*/
public String enterOwnComment ();
/**
* Allows the user to enter own company name.
- *
+ * <p>
* @return Company name
*/
public String enterOwnCompanyName ();
/**
* Allows the user to enter own country code.
- *
+ * <p>
* @return Country code
*/
public String enterOwnCountryCode ();
/**
* Allows the user to enter own email address.
- *
+ * <p>
* @return Email address
*/
public String enterOwnEmailAddress ();
/**
* Allows the user to enter own family name.
- *
+ * <p>
* @return Family name
*/
public String enterOwnFamilyName ();
/**
* Allows the user to enter own fax number.
- *
+ * <p>
* @return Fax number
*/
public String enterOwnFaxNumber ();
/**
* Allows the user to enter own gender.
- *
+ * <p>
* @return Gender
*/
public Gender enterOwnGender ();
/**
* Allows the user to enter own phone number.
- *
+ * <p>
* @return Phone number
*/
public String enterOwnPhoneNumber ();
/**
* Allows the user to enter own street and house number.
- *
+ * <p>
* @return Street and house number
*/
public String enterOwnStreet ();
/**
* Allows the user to enter own surname.
- *
+ * <p>
* @return Surname
*/
public String enterOwnFirstName ();
/**
* Allows the user to enter own ZIP code.
- *
+ * <p>
* @return ZIP code
*/
public int enterOwnZipCode ();
/**
* Adds given contact to address book
- *
- * @param contact Contact being added
- * TODO Add check for book size
+ * <p>
+ * @param contact Contact being added TODO Add check for book size
*/
public void registerContact (final Contact contact);
/**
* Adds given Contact instance to list
- *
+ * <p>
* @param contact Contact instance to add
- * @throws org.mxchange.addressbook.exceptions.ContactAlreadyAddedException If the contact is already added
+ * @throws org.mxchange.addressbook.exceptions.ContactAlreadyAddedException
+ * If the contact is already added
*/
public void addContact (final Contact contact) throws ContactAlreadyAddedException;
/**
* The user can change address data, like street, ZIP code, city and country
* of given Contact instance.
- *
+ * <p>
* @param contact Instance to change data
*/
public void doChangeAddressData (final Contact contact);
/**
* The user can change name data, like gender, surname, family name and
* company name (if business contact).
- *
+ * <p>
* @param contact Instance to change data
*/
public void doChangeNameData (final Contact contact);
/**
* The user can change other data, like phone numbers or comments.
- *
+ * <p>
* @param contact Instance to change data
*/
public void doChangeOtherData (final Contact contact);
/**
* Let the user change own data
+ * <p>
* @throws java.sql.SQLException If an SQL error occurs
* @throws java.io.IOException If an IO error occurs
* @throws java.lang.NoSuchMethodException If a method cannot be found
* @throws java.lang.IllegalAccessException If a method is not accessible
* @throws java.lang.reflect.InvocationTargetException Any other problems?
*/
- public void doChangeOwnData () throws IOException , SQLException, NoSuchMethodException, IllegalAccessException, InvocationTargetException;
+ public void doChangeOwnData () throws IOException, SQLException, NoSuchMethodException, IllegalAccessException, InvocationTargetException;
/**
* Let the user delete other address
/**
* Asks user for own data
- * @throws org.mxchange.addressbook.exceptions.ContactAlreadyAddedException If own contact is already added
+ * <p>
+ * @throws org.mxchange.addressbook.exceptions.ContactAlreadyAddedException
+ * If own contact is already added
* @throws java.io.IOException If an IO error was found
*/
public void doEnterOwnData () throws ContactAlreadyAddedException, IOException;
/**
* Checks whether own contact is already added by checking all entries for
* isOwnContact flag
- *
+ * <p>
* @return Whether own contact is already added
* @throws java.io.IOException If an IO error occurs
*/
/**
* Getter for translated column name at given index.
- *
+ * <p>
* @param columnIndex Column index
- * @return Human-readable column name
- * TODO: This is needed for TableModel in Swing
+ * @return Human-readable column name TODO: This is needed for TableModel in
+ * Swing
*/
public String getTranslatedColumnName (final int columnIndex);
/**
* Somewhat "getter" for value from given row and column index
- *
+ * <p>
* @param rowIndex Row index
* @param columnIndex Column index
* @return Value from given row/column
* @throws java.lang.NoSuchMethodException If the method was not found
- * @throws java.lang.IllegalAccessException If the accessed method was not public
- * @throws java.lang.reflect.InvocationTargetException Something else happened?
- * TODO: This is needed for TableModel in Swing
+ * @throws java.lang.IllegalAccessException If the accessed method was not
+ * public
+ * @throws java.lang.reflect.InvocationTargetException Something else
+ * happened? TODO: This is needed for TableModel in Swing
*/
public Object getValueFromRowColumn (final int rowIndex, final int columnIndex) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException;
/**
* Getter for column name at given index.
- *
+ * <p>
* @param columnIndex Column index
- * @return Database column name
- * TODO: This is needed for TableModel in Swing
+ * @return Database column name TODO: This is needed for TableModel in Swing
*/
public String getColumnName (final int columnIndex);
/**
* Getter for column count
- * @return Column count
- * TODO: This is needed for TableModel in Swing
+ * <p>
+ * @return Column count TODO: This is needed for TableModel in Swing
*/
public int getColumnCount ();
}
projects / jfinancials-swing.git / blobdiff