Home

Contribute

Source code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

/*******************************************************************************
 * Copyright (c) 2013 Boeing.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Boeing - initial API and implementation
 *******************************************************************************/
package org.eclipse.osee.ats.api.workflow.log;

import java.util.Date;
import java.util.List;
import org.eclipse.osee.ats.api.user.IAtsUser;
import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;

/**
 * @author Donald G. Dunne
 */
public interface IAtsLog {

   public abstract String getHtml() throws OseeCoreException;

   public abstract String getHtml(boolean showLog) throws OseeCoreException;

   public abstract List<IAtsLogItem> getLogItems() throws OseeCoreException;

   public abstract Date getLastStatusDate() throws OseeCoreException;

   public abstract void putLogItems(List<IAtsLogItem> items);

   public abstract List<IAtsLogItem> getLogItemsReversed() throws OseeCoreException;

   /**
    * Used to reset the original originated user. Only for internal use. Kept for backward compatibility.
    */
   public abstract void internalResetOriginator(IAtsUser user) throws OseeCoreException;

   /**
    * Used to reset the original originated user. Only for internal use. Kept for backward compatibility.
    */
   public abstract void internalResetCreatedDate(Date date) throws OseeCoreException;

   public abstract String internalGetCancelledReason() throws OseeCoreException;

   /**
    * This method is replaced by workItem.getCompletedFromState. Kept for backward compatibility.
    */
   public abstract String internalGetCompletedFromState() throws OseeCoreException;

   /**
    * @param state name of state or null
    */
   public abstract void addLog(LogType type, String state, String msg) throws OseeCoreException;

   public abstract void addLogItem(IAtsLogItem item) throws OseeCoreException;

   public abstract void addLog(LogType type, String state, String msg, Date date, IAtsUser user) throws OseeCoreException;

   public abstract void clearLog();

   public abstract String getTable() throws OseeCoreException;

   public abstract IAtsLogItem getLastEvent(LogType type) throws OseeCoreException;

   public abstract IAtsLogItem getStateEvent(LogType type, String stateName) throws OseeCoreException;

   public abstract IAtsLogItem getStateEvent(LogType type) throws OseeCoreException;

}