org.cp.elements.lang.Auditable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development.

There is a newer version: 2.0.0-M1

Show newest version

/*
 * Copyright 2016 Author or Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.cp.elements.lang;

import java.util.Calendar;

/**
 * The Auditable interface defines a contract for objects that need to be audited, allowing all changes to be tracked
 * in fine-grained detail by specifying who, when and what made changes to this object.
 *
 * @author John J. Blum
 * @param  an object type for tracking the user.
 * @param  an object type for tracking the process.
 * @see java.util.Calendar
 * @see org.cp.elements.lang.Identifiable
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public interface Auditable {

  /**
   * Gets the user who is responsible for the creation of this object.
   *
   * @return an object denoting the user who created this object.
   */
  USER getCreatedBy();

  /**
   * Sets the user who is responsible for the creation of this object.
   *
   * @param user an object denoting the user who created this object.
   */
  void setCreatedBy(USER user);

  /**
   * Gets the date and time when this object was created.
   *
   * @return a Calendar object denoting the date and time when this object was created.
   */
  Calendar getCreatedDateTime();

  /**
   * Sets the date and time when this object was created.
   *
   * @param dateTime a Calendar object denoting the date and time when this object was created.
   */
  void setCreatedDateTime(Calendar dateTime);

  /**
   * Gets the process (the what) that functionally created this object.
   *
   * @return an object denoting the process that created this object.
   */
  PROCESS getCreatingProcess();

  /**
   * Sets the process (the what) that functionally created this object.
   *
   * @param process an object denoting the process that created this object.
   */
  void setCreatingProcess(PROCESS process);

  /**
   * Gets the user who was last responsible for modifying this object.
   *
   * @return an object denoting the last user responsible for modifying this object.
   */
  USER getLastModifiedBy();

  /**
   * Gets the last date and time when this object was modified.
   *
   * @return a Calendar object denoting the date and time when this object was last modified.
   */
  Calendar getLastModifiedDateTime();

  /**
   * Gets the process (the what) that was last responsible for modifying this object.
   *
   * @return an object denoting the last process responsible for modifying this object.
   */
  PROCESS getLastModifyingProcess();

  /**
   * Determines whether this Auditable object has been modified.  One particular implementation suggests that
   * if the last modified date/time does not match the current modified date/time then the Auditable object has
   * been modified.  Of course, if any propery value of the object has changed, then the object has been modified.
   *
   * @return a boolean value indicating whether this Auditable object has been modified or not.
   */
  boolean isModified();

  /**
   * Determines whether the specified property of this Auditable object has been modified.  The property has been
   * changed if the old and new value are not equal in value.
   *
   * @param propertyName a String value specifying the name of the property to check for modification.
   * @return a boolean value indicating whether the specified property of this Auditable object, identified by name,
   * has been modified.
   */
  boolean isModified(String propertyName);

  /**
   * Gets the user who is responsible for modifying this object.
   *
   * @return an object denoting the user who modified this object.
   */
  USER getModifiedBy();

  /**
   * Sets the user who is responsible for modifying this object.
   *
   * @param user an object denoting the user who modified this object.
   */
  void setModifiedBy(USER user);

  /**
   * Gets the date and time when this object was modified.
   *
   * @return a Calendar object denoting the date and time when this object was modified.
   */
  Calendar getModifiedDateTime();

  /**
   * Sets the date and time when this object was modified.
   *
   * @param dateTime a Calendar object denoting the date and time when this object was modified.
   */
  void setModifiedDateTime(Calendar dateTime);

  /**
   * Gets the process (the what) that functionally modified this object.
   *
   * @return an object denoting the process that modified this object.
   */
  PROCESS getModifyingProcess();

  /**
   * Sets the process (the what) that functionally modified this object.
   *
   * @param process an object denoting the process that modified this object.
   */
  void setModifyingProcess(PROCESS process);

}