@openui5/sap.ui.fl 1.97.1 → 1.100.0

package/src/sap/ui/fl/Change.js

@@ -87,9 +87,11 @@ sap.ui.define([
 	Change.applyState = {
 		INITIAL: 0,
 		APPLYING: 1,
-		APPLY_FINISHED: 2,
+		APPLY_FINISHED: 2, // Deprecated
 		REVERTING: 3,
-		REVERT_FINISHED: 4
+		REVERT_FINISHED: 4,
+		APPLY_SUCCESSFUL: 5,
+		APPLY_FAILED: 6
 	};
 
 	Change.operations = {
@@ -154,10 +156,22 @@ sap.ui.define([
 		this.setApplyState(Change.applyState.APPLYING);
 	};
 
-	Change.prototype.markFinished = function(oResult) {
+	// Deprecated, use markSuccessful or markFailed instead
+	Change.prototype.markFinished = function(oResult, bApplySuccessful) {
 		this._aQueuedProcesses.pop();
 		this._resolveChangeProcessingPromiseWithError(Change.operations.APPLY, oResult);
-		this.setApplyState(Change.applyState.APPLY_FINISHED);
+		var sNewApplyState = bApplySuccessful !== false
+			? Change.applyState.APPLY_SUCCESSFUL
+			: Change.applyState.APPLY_FAILED;
+		this.setApplyState(sNewApplyState);
+	};
+
+	Change.prototype.markSuccessful = function(oResult) {
+		this.markFinished(oResult, true);
+	};
+
+	Change.prototype.markFailed = function(oResult) {
+		this.markFinished(oResult, false);
 	};
 
 	Change.prototype.startReverting = function() {
@@ -174,8 +188,16 @@ sap.ui.define([
 		return this.getApplyState() === Change.applyState.APPLYING;
 	};
 
+	Change.prototype.isSuccessfullyApplied = function() {
+		return this.getApplyState() === Change.applyState.APPLY_SUCCESSFUL;
+	};
+
+	Change.prototype.hasApplyProcessFailed = function() {
+		return this.getApplyState() === Change.applyState.APPLY_FAILED;
+	};
+
 	Change.prototype.isApplyProcessFinished = function() {
-		return this.getApplyState() === Change.applyState.APPLY_FINISHED;
+		return this.isSuccessfullyApplied() || this.hasApplyProcessFailed();
 	};
 
 	Change.prototype.hasRevertProcessStarted = function() {
@@ -280,37 +302,6 @@ sap.ui.define([
 		return true;
 	};
 
-	/**
-	 * Returns if the change is valid
-	 * @returns {boolean} <code>true</code> if the change is valid (all mandatory fields are filled, etc.)
-	 *
-	 * @public
-	 */
-	Change.prototype.isValid = function () {
-		var bIsValid = true;
-
-		if (typeof (this._oDefinition) !== "object") {
-			bIsValid = false;
-		}
-		if (!this._oDefinition.fileType) {
-			bIsValid = false;
-		}
-		if (!this._oDefinition.fileName) {
-			bIsValid = false;
-		}
-		if (!this._oDefinition.changeType) {
-			bIsValid = false;
-		}
-		if (!this._oDefinition.layer) {
-			bIsValid = false;
-		}
-		if (!this._oDefinition.originalLanguage) {
-			bIsValid = false;
-		}
-
-		return bIsValid;
-	};
-
 	/**
 	 * Returns if the type of the change is <code>variant</code>.
 	 * @returns {boolean} <code>true</code> if the <code>fileType</code> of the change file is a variant
@@ -324,7 +315,7 @@ sap.ui.define([
 	/**
 	 * Returns the change type.
 	 *
-	 * @returns {String} Change type of the file, for example <code>LabelChange</code>
+	 * @returns {string} Change type of the file, for example <code>LabelChange</code>
 	 * @public
 	 */
 	Change.prototype.getChangeType = function () {
@@ -336,7 +327,7 @@ sap.ui.define([
 	/**
 	 * Returns the file name.
 	 *
-	 * @returns {String} <code>fileName</code> of the file
+	 * @returns {string} <code>fileName</code> of the file
 	 * @public
 	 */
 	Change.prototype.getFileName = function () {
@@ -348,27 +339,11 @@ sap.ui.define([
 	/**
 	 * Returns the file type.
 	 *
-	 * @returns {String} <code>fileType</code> of the file
+	 * @returns {string} <code>fileType</code> of the file
 	 * @public
 	 */
 	Change.prototype.getFileType = function () {
-		if (this._oDefinition) {
-			return this._oDefinition.fileType;
-		}
-	};
-
-	/**
-	 * Returns the original language in ISO 639-1 format.
-	 *
-	 * @returns {String} Original language
-	 *
-	 * @public
-	 */
-	Change.prototype.getOriginalLanguage = function () {
-		if (this._oDefinition && this._oDefinition.originalLanguage) {
-			return this._oDefinition.originalLanguage;
-		}
-		return "";
+		return this._oDefinition.fileType;
 	};
 
 	/**
@@ -398,7 +373,7 @@ sap.ui.define([
 	/**
 	 * Returns the namespace. The namespace of the change is also the namespace of the change file in the repository.
 	 *
-	 * @returns {String} Namespace of the change file
+	 * @returns {string} Namespace of the change file
 	 *
 	 * @public
 	 */
@@ -420,7 +395,7 @@ sap.ui.define([
 	/**
 	 * Returns the name of module which this change refers to (XML or JS).
 	 *
-	 * @returns {String} Module name
+	 * @returns {string} Module name
 	 *
 	 * @public
 	 */
@@ -442,7 +417,7 @@ sap.ui.define([
 	/**
 	 * Returns the project ID of the change. There might be multiple projects adapting a base application. The project ID helps to see where the change is coming from. If no <code>projectIDid</code> is specified, it is the <code>sap.app/id</code>.
 	 *
-	 * @returns {String} Project ID of the change file
+	 * @returns {string} Project ID of the change file
 	 *
 	 * @public
 	 */
@@ -450,17 +425,6 @@ sap.ui.define([
 		return this._oDefinition.projectId;
 	};
 
-	/**
-	 * Sets the project ID.
-	 *
-	 * @param {string} sProjectId - Project ID of the change file
-	 *
-	 * @public
-	 */
-	Change.prototype.setProjectId = function (sProjectId) {
-		this._oDefinition.projectId = sProjectId;
-	};
-
 	/**
 	 * Returns the ID of the change.
 	 * @returns {string} ID of the change file
@@ -529,38 +493,6 @@ sap.ui.define([
 		this._oDefinition.selector = oSelector;
 	};
 
-	/**
-	 * Returns the source system of the change.
-	 *
-	 * @returns {String} Source system of the change file
-	 *
-	 * @public
-	 */
-	Change.prototype.getSourceSystem = function () {
-		return this._oDefinition.sourceSystem;
-	};
-
-	/**
-	 * Returns the source client of the change.
-	 *
-	 * @returns {String} Source client of the change file
-	 *
-	 * @public
-	 */
-	Change.prototype.getSourceClient = function () {
-		return this._oDefinition.sourceClient;
-	};
-
-	/**
-	 * Returns the user ID of the owner.
-	 * @returns {string} ID of the owner
-	 *
-	 * @public
-	 */
-	Change.prototype.getOwnerId = function () {
-		return this._oDefinition.support ? this._oDefinition.support.user : "";
-	};
-
 	/**
 	 * Returns the text in the current language for a given ID.
 	 *
@@ -613,80 +545,15 @@ sap.ui.define([
 		}
 	};
 
-	/**
-	 * Returns <code>true</code> if the current layer is the same as the layer in which the change was created, or if the change is from the end-user layer and was created for this user.
-	 * @returns {boolean} <code>true</code> if the change file is read only
-	 *
-	 * @deprecated
-	 * @public
-	 */
-	Change.prototype.isReadOnly = function () {
-		return this._isReadOnlyDueToLayer() || this._isReadOnlyWhenNotKeyUser() || this.isChangeFromOtherSystem();
-	};
-
-	/**
-	 * Checks if the change is read only, because the current user is not a key user and the change is "shared".
-	 * @returns {boolean} <code>true</code> if the change is read only
-	 *
-	 * @deprecated
-	 * @private
-	 */
-	Change.prototype._isReadOnlyWhenNotKeyUser = function () {
-		if (this.isUserDependent()) {
-			return false; // the user always can edit its own changes
-		}
-
-		var sReference = this.getDefinition().reference;
-		if (!sReference) {
-			return true; // without a reference the right to edit or delete a change cannot be determined
-		}
-
-		var oSettings = Settings.getInstanceOrUndef();
-		if (!oSettings) {
-			return true; // without settings the right to edit or delete a change cannot be determined
-		}
-		// a key user can edit changes
-		return !oSettings.isKeyUser();
-	};
-
-	/**
-	 * Returns <code>true</code> if the label is read only. The label might be read only because of the current layer or because the logon language differs from the original language of the change file.
-	 *
-	 * @returns {boolean} <code>true</code> if the label is read only
-	 *
-	 * @deprecated
-	 * @public
-	 */
-	Change.prototype.isLabelReadOnly = function () {
-		if (this._isReadOnlyDueToLayer()) {
-			return true;
-		}
-		return this._isReadOnlyDueToOriginalLanguage();
-	};
-
-	/**
-	 * Checks if the layer allows modifying the file.
-	 * @returns {boolean} <code>true</code> if the change is read only
-	 *
-	 * @deprecated
-	 * @private
-	 */
-	Change.prototype._isReadOnlyDueToLayer = function () {
-		var sCurrentLayer;
-		sCurrentLayer = this._bUserDependent ? Layer.USER : LayerUtils.getCurrentLayer();
-		return (this._oDefinition.layer !== sCurrentLayer);
-	};
-
 	/**
 	 * Checks if change is read only because of its source system.
 	 * @returns {boolean} <code>true</code> if the change is from another system
 	 *
-	 * @deprecated
 	 * @public
 	 */
 	Change.prototype.isChangeFromOtherSystem = function () {
-		var sSourceSystem = this.getSourceSystem();
-		var sSourceClient = this.getSourceClient();
+		var sSourceSystem = this._oDefinition.sourceSystem;
+		var sSourceClient = this._oDefinition.sourceClient;
 		if (!sSourceSystem || !sSourceClient) {
 			return false;
 		}
@@ -702,28 +569,6 @@ sap.ui.define([
 		return (sSourceSystem !== sSystem || sSourceClient !== sClient);
 	};
 
-	/**
-	 * A change can only be modified if the current language equals the original language.
-	 * Returns <code>false</code> if the current language does not equal the original language of the change file.
-	 * Returns <code>false</code> if the original language is initial.
-	 *
-	 * @deprecated
-	 * @returns {boolean} <code>true</code> if the current logon language equals the original language of the change file
-	 *
-	 * @private
-	 */
-	Change.prototype._isReadOnlyDueToOriginalLanguage = function () {
-		var sCurrentLanguage;
-		var sOriginalLanguage;
-
-		sOriginalLanguage = this.getOriginalLanguage();
-		if (!sOriginalLanguage) {
-			return false;
-		}
-
-		sCurrentLanguage = Utils.getCurrentLanguage();
-		return (sCurrentLanguage !== sOriginalLanguage);
-	};
 
 	/**
 	 * Marks the current change to be deleted persistently.
@@ -799,7 +644,7 @@ sap.ui.define([
 	/**
 	 * Gets the creation timestamp.
 	 *
-	 * @returns {String} Creation timestamp
+	 * @returns {string} Creation timestamp
 	 *
 	 * @public
 	 */
@@ -841,15 +686,6 @@ sap.ui.define([
 		}
 	};
 
-	Change.prototype.getFullFileIdentifier = function () {
-		var sLayer = this.getLayer();
-		var sNamespace = this.getNamespace();
-		var sFileName = this.getDefinition().fileName;
-		var sFileType = this.getDefinition().fileType;
-
-		return sLayer + "/" + sNamespace + "/" + sFileName + "." + sFileType;
-	};
-
 	/**
 	 * Adds the selector to the dependent selector list.
 	 *
@@ -1049,26 +885,6 @@ sap.ui.define([
 		this.setRevertData(null);
 	};
 
-	/**
-	 * Returns the undo operations.
-	 *
-	 * @returns {Array<*>} Array of undo operations
-	 * @public
-	 */
-	Change.prototype.getUndoOperations = function() {
-		return this._aUndoOperations;
-	};
-
-	/**
-	 * Sets the undo operations.
-	 *
-	 * @param {Array<*>} aData - Undo operations
-	 * @public
-	 */
-	Change.prototype.setUndoOperations = function(aData) {
-		this._aUndoOperations = aData;
-	};
-
 	Change.prototype.getExtensionPointInfo = function() {
 		return this._oExtensionPointInfo;
 	};
@@ -1077,14 +893,6 @@ sap.ui.define([
 		this._oExtensionPointInfo = oExtensionPointInfo;
 	};
 
-	/**
-	 * Resets the undo operations
-	 * @public
-	 */
-	Change.prototype.resetUndoOperations = function() {
-		this.setUndoOperations(null);
-	};
-
 	/**
 	 * Creates and returns an instance of a change instance.
 	 *
@@ -1145,7 +953,7 @@ sap.ui.define([
 			namespace: oPropertyBag.namespace || Utils.createNamespace(oPropertyBag, sFileType), //TODO: we need to think of a better way to create namespaces from Adaptation projects.
 			projectId: oPropertyBag.projectId || (oPropertyBag.reference && oPropertyBag.reference.replace(".Component", "")) || "",
 			creation: "",
-			originalLanguage: Utils.getCurrentLanguage(),
+			originalLanguage: Utils.getCurrentLanguage() || "",
 			support: {
 				generator: oPropertyBag.generator || "Change.createInitialFileContent",
 				service: oPropertyBag.service || "",